DescribeIpGeolocationInfos

Last updated: 2021-01-22 09:55:40

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to query the information of IP addresses, including their geographical locations and networks.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeIpGeolocationInfos.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
AddressIps.N Yes Array of String IP addresses to be queried. Both IPv4 and IPv6 addresses are supported.
Fields No IpField Fields of the IP addresses to be queried, including Country, Province, City, Region, Isp, AsName and AsId

3. Output Parameters

Parameter Name Type Description
AddressInfo Array of IpGeolocationInfo IP address details
Total Integer Number of IP addresses
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the IP location

Input Example

https://vpc.tencentcloudapi.com/?Action=DescribeIpGeolocationInfos
&AddressIps.0=2001:1200::
&AddressIps.1=8.8.8.8
&Fields.Country=True
&Fields.Province=True
&Fields.City=True
&Fields.Region=True
&Fields.Isp=True
&<Common request parameters>

Output Example

{
  "Response": {
    "Total": 2,
    "AddressInfo": [
      {
        "AddressIp": "2001:1200::",
        "Country": "Mexico",
        "Province": "tabasco",
        "City": "miguel hidalgo",
        "Region": "Unknown",
        "Isp": "protel i-next, s.a. de c.v., mx"
      },
      {
        "AddressIp": "8.8.8.8",
        "Country": "United States",
        "Province": "california",
        "City": "mountain view",
        "Region": "Unknown",
        "Isp": "google - google inc., us"
      }
    ],
    "RequestId": "6d3e1ba5-a3d0-41d4-93f7-4992a2e18b9d"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalServerError Internal error.
InvalidAccount.NotSupported This account is not supported.
InvalidParameter A parameter error occurred.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
MissingParameter Missing parameter.