tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeIpGeolocationInfos

Last updated: 2023-08-23 14:11:28

1. API Description

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

This API is used to query the location and network information of one or more IP addresses.
This API will be discontinued soon and is only available for existing users.

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

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 Params. The value used for this API: DescribeIpGeolocationInfos.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
AddressIps.N Yes Array of String The list of IP addresses (only IPv4 addresses are available currently) to be queried; upper limit: 100
Fields No IpField Fields of the IP addresses to be queried.

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 location of IPs

This example shows you how to query the location of IPs.

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIpGeolocationInfos
<Common request parameters>

{
    "AddressIps": [
        "8.8.8.8",
        "2001:1200::"
    ],
    "Fields": {
        "Province": "True",
        "Country": "True",
        "Region": "True",
        "Isp": "True",
        "City": "True"
    }
}

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.Combination Invalid input parameters
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
MissingParameter Missing parameter.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy