DescribeInternetAddress

Last updated: 2021-01-27 15:00:13

1. API Description

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

This API is used to obtain the public IP address of an internet tunnel.

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 parameter. The value used for this API: DescribeInternetAddress.
Version Yes String Common parameter. The value used for this API: 2018-04-10.
Region No String Common parameter. This parameter is not required for this API.
Offset No Integer Offset. Default value: 0.
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
Filters.N No Array of Filter Filter conditions:
  • AddrType, address type. Valid values: 0: BGP; 1: China Telecom; 2: China Mobile; 3: China Unicom
  • AddrProto, address protocol. Valid values: 0: IPv4; 1: IPv6
  • Status, address status. Valid values: 0: in use; 1: disabled; 2: returned
  • Subnet, public IP address array

  • Public IP address ID array

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of public IP addresses for internet tunnels
    Subnets Array of InternetAddressDetail List of the public IP addresses for internet tunnels
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Obtaining the public IP addresses you have applied for

    Input Example

    https://dc.tencentcloudapi.com/?Action=DescribeInternetAddress
    &Limit=20
    &Offset=1
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "TotalCount": 1,
        "Subnets": [
          {
            "Status": 0,
            "Subnet": "220.110.1.0",
            "MaskLen": 30,
            "AddrType": 0,
            "AppId": 251010426,
            "InstanceId": "ipv4-qmda2nqv",
            "AddrProto": 0,
            "StopTime": "2020-09-22 00:00:00",
            "Region": "gz",
            "ApplyTime": "2020-09-22 00:00:00",
            "ReleaseTime": "2020-09-22 00:00:00"
          }
        ],
        "RequestId": "24a0d7e5-4c13-49be-aa16-94f698fbef3e"
      }
    }

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback