调用ListIpGeolocations接口查询IP归属地。

限制说明

本接口暂不支持在OpenAPIExplorer中运行调用。如果您想使用OpenAPI Explorer来调用该接口,请先提交工单获取调用权限。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
CountryCode String CN

公网IP所在的国家,该参数值符合ISO 3166定义,您可以自行查询。

CityCode String HK

公网IP所在的城市,该参数值符合ISO 3166定义,您可以自行查询。

Ipv4Prefix String 203.0.XX.XX/24

要查询的IPv4地址段。

例如:203.0.XX.XX/24,如只输入203.0.XX.XX,则查询203.0.XX.XX/32

ResourcePoolName String Alibaba_Cloud

公网IP所在资源池的名称,取值:

  • Alibaba_Cloud(默认值):阿里云。
  • Alibaba_CDN:阿里云CDN节点。
NextToken String caeba0bbb2be03f84eb48b699f0a4883

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
MaxResults Integer 20

分页查询时每页显示的条目数。取值范围:1~100。默认值:20

Action String ListIpGeolocations

系统规定参数。取值:ListIpGeolocations

返回数据

名称 类型 示例值 描述
NextToken String caeba0bbb2be03f84eb48b699f0a4883

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 365F4154-92F6-4AE4-92F8-7FF34B540710

请求ID。

TotalCount Integer 100

查询到归属地的IP总数。

MaxResults Integer 20

分页查询时每页显示条数。

IpGeolocationModels Array of IpGeolocationModel

IP归属地列表。

IpGeolocationModel
CityCode String HK

公网IP所在的城市,参数值符合ISO 3166定义。

ResourcePoolName String Alibaba_Cloud

资源池名称。

CountryCode String CN

公网IP所在的国家,参数值符合ISO 3166定义。

Ipv4Prefix String 203.0.XX.XX/24

IPv4地址段。

示例

请求示例

http(s)://[Endpoint]/?CountryCode=CN
&CityCode=HK
&Ipv4Prefix=203.0.XX.XX/24
&ResourcePoolName=Alibaba_Cloud
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=20
&Action=ListIpGeolocations
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListIpGeolocationsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>365F4154-92F6-4AE4-92F8-7FF34B540710</RequestId>
    <TotalCount>100</TotalCount>
    <MaxResults>20</MaxResults>
    <IpGeolocationModels>
        <CityCode>HK</CityCode>
        <ResourcePoolName>Alibaba_Cloud</ResourcePoolName>
        <CountryCode>CN</CountryCode>
        <Ipv4Prefix>203.0.XX.XX/24</Ipv4Prefix>
    </IpGeolocationModels>
</ListIpGeolocationsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId" : "365F4154-92F6-4AE4-92F8-7FF34B540710",
  "TotalCount" : 100,
  "MaxResults" : 20,
  "IpGeolocationModels" : [ {
    "CityCode" : "HK",
    "ResourcePoolName" : "Alibaba_Cloud",
    "CountryCode" : "CN",
    "Ipv4Prefix" : "203.0.XX.XX/24"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 OperationFailed.QueryIpPoolFailed Failed to query IP resource pool. 查询IP资源库失败
400 OperationFailed.InvokeApi Failed to invoke the API operation. 调用API失败
400 OperationFailed.InternalError An internal error occurred. 内部错误
400 IllegalParam.Ipv4Prefix The parameter Ipv4Prefix is invalid. 参数Ipv4Prefix非法
400 IllegalParam.ResourcePoolName The parameter ResourcePoolName is invalid. 参数ResourcePoolName非法
400 OperationFailed.NoPermission You are not authorized to call the API operation. 没有接口调用权限

访问错误中心查看更多错误码。