有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口 (DescribeAddresses) 用于查询一个或多个弹性公网IP(简称 EIP)的详细信息。

  • 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的 EIP。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAddresses。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
AddressIds.N Array of String 标识 EIP 的唯一 ID 列表。EIP 唯一 ID 形如:eip-11112222。参数不支持同时指定AddressIdsFilters.address-id
示例值:eip-11112222
Filters.N Array of Filter 每次请求的Filters的上限为10,Filter.Values的上限为100。详细的过滤条件如下:
  • address-id - String - 是否必填:否 - (过滤条件)按照 EIP 的唯一 ID 过滤。EIP 唯一 ID 形如:eip-11112222。
  • address-name - String - 是否必填:否 - (过滤条件)按照 EIP 名称过滤。不支持模糊过滤。
  • address-ip - String - 是否必填:否 - (过滤条件)按照 EIP 的 IP 地址过滤。
  • address-status - String - 是否必填:否 - (过滤条件)按照 EIP 的状态过滤。状态包含:'CREATING','BINDING','BIND','UNBINDING','UNBIND','OFFLINING','BIND_ENI'。
  • instance-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的实例 ID 过滤。实例 ID 形如:ins-11112222。
  • private-ip-address - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的内网 IP 过滤。
  • network-interface-id - String - 是否必填:否 - (过滤条件)按照 EIP 绑定的弹性网卡 ID 过滤。弹性网卡 ID 形如:eni-11112222。
  • is-arrears - String - 是否必填:否 - (过滤条件)按照 EIP 是否欠费进行过滤。(TRUE:EIP 处于欠费状态|FALSE:EIP 费用状态正常)
  • address-type - String - 是否必填:否 - (过滤条件)按照 IP类型 进行过滤。可选值:'WanIP', 'EIP','AnycastEIP','HighQualityEIP'。默认值是'EIP'。
  • address-isp - String - 是否必填:否 - (过滤条件)按照 运营商类型 进行过滤。可选值:'BGP','CMCC','CUCC', 'CTCC'
  • dedicated-cluster-id - String - 是否必填:否 - (过滤条件)按照 CDC 的唯一 ID 过滤。CDC 唯一 ID 形如:cluster-11112222。
  • tag-key - String - 是否必填:否 - (过滤条件)按照标签键进行过滤。
  • tag-value - String - 是否必填:否 - (过滤条件)按照标签值进行过滤。
  • tag:tag-key - String - 是否必填:否 - (过滤条件)按照标签键值对进行过滤。tag-key使用具体的标签键进行替换。
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 中的相关小节。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的 EIP 数量。
    示例值:10
    AddressSet Array of Address EIP 详细信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询弹性公网EIP

    查询弹性公网EIP。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
    &AddressIds.0=eip-hxlqja90
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 0,
            "AddressSet": [
                {
                    "AddressId": "eip-12345678",
                    "AddressName": "abc",
                    "AddressStatus": "UNBIND",
                    "AddressIp": "34.3.4.5.6",
                    "InstanceId": "ins-12345678",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "NetworkInterfaceId": "eni-12345678",
                    "PrivateAddressIp": "10.2.3.4",
                    "IsArrears": true,
                    "IsBlocked": true,
                    "IsEipDirectConnection": true,
                    "AddressType": "WanIp",
                    "CascadeRelease": true,
                    "EipAlgType": {
                        "Ftp": true,
                        "Sip": true
                    },
                    "InternetServiceProvider": "BGP",
                    "LocalBgp": true,
                    "Bandwidth": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "TagSet": [
                        {
                            "Key": "abc",
                            "Value": "abc"
                        }
                    ],
                    "DeadlineDate": "2020-09-22",
                    "InstanceType": "abc",
                    "Egress": "abc"
                }
            ],
            "RequestId": "abc"
        }
    }

    示例2 查询普通公网IP

    查询普通公网IP。

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeAddresses
    &Filters.0.Name=address-type
    &Filters.0.Values.0=WanIP
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 0,
            "AddressSet": [
                {
                    "AddressId": "eip-12345678",
                    "AddressName": "abc",
                    "AddressStatus": "UNBIND",
                    "AddressIp": "34.3.4.5.6",
                    "InstanceId": "ins-12345678",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "NetworkInterfaceId": "eni-12345678",
                    "PrivateAddressIp": "192.2.3.4",
                    "IsArrears": true,
                    "IsBlocked": true,
                    "IsEipDirectConnection": true,
                    "AddressType": "WanIp",
                    "CascadeRelease": true,
                    "EipAlgType": {
                        "Ftp": true,
                        "Sip": true
                    },
                    "InternetServiceProvider": "abc",
                    "LocalBgp": true,
                    "Bandwidth": 1,
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "TagSet": [
                        {
                            "Key": "abc",
                            "Value": "abc"
                        }
                    ],
                    "DeadlineDate": "2020-09-22",
                    "InstanceType": "abc",
                    "Egress": "abc"
                }
            ],
            "RequestId": "abc"
        }
    }

    示例3 查询EIP信息

    查询EIP信息。

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeAddresses
    <公共请求参数>
    
    {}

    输出示例

    {
        "Response": {
            "TotalCount": 2,
            "AddressSet": [
                {
                    "AddressId": "eip-qhx8udkc",
                    "AddressName": "未命名",
                    "AddressIp": "1.14.91.34",
                    "AddressStatus": "UNBIND",
                    "AddressType": "EIP",
                    "InstanceId": "ins-wf123456",
                    "InstanceType": null,
                    "NetworkInterfaceId": "eni-12345678",
                    "PrivateAddressIp": "10.2.3.4",
                    "IsArrears": false,
                    "IsBlocked": false,
                    "IsEipDirectConnection": false,
                    "EipAlgType": {
                        "Ftp": true,
                        "Sip": true
                    },
                    "LocalBgp": false,
                    "CascadeRelease": false,
                    "CreatedTime": "2022-08-11T03:57:05Z",
                    "TagSet": [],
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "Bandwidth": 1,
                    "DeadlineDate": null,
                    "InternetServiceProvider": "BGP"
                },
                {
                    "AddressId": "eip-qygpzm9y",
                    "AddressName": "未命名",
                    "AddressIp": "1.14.90.212",
                    "AddressStatus": "UNBIND",
                    "AddressType": "EIP",
                    "InstanceId": "ins-12345678",
                    "InstanceType": null,
                    "NetworkInterfaceId": "eni-12345678",
                    "PrivateAddressIp": "10.3.4.5.6",
                    "IsArrears": false,
                    "IsBlocked": false,
                    "IsEipDirectConnection": false,
                    "EipAlgType": {
                        "Ftp": true,
                        "Sip": true
                    },
                    "LocalBgp": false,
                    "CascadeRelease": false,
                    "CreatedTime": "2022-08-11T03:47:03Z",
                    "TagSet": [],
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "Bandwidth": 1,
                    "DeadlineDate": null,
                    "InternetServiceProvider": "BGP"
                }
            ],
            "RequestId": "4ead34c4-3112-40fe-bbde-2295eee9d664"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InvalidParameter 参数错误。
    InvalidParameter.InvalidFilter 该过滤规则不合法。
    InvalidParameterValue.AddressIdMalformed 该地址ID不合法。
    InvalidParameterValue.InvalidDedicatedClusterId 传入的DedicatedClusterId有误。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.NetworkInterfaceIdMalformed 网络接口ID不正确。
    InvalidParameterValue.ResourceIdMalformed 资源ID不正确。
    LimitExceeded.NumberOfFilters 过滤参数名称超过限制。
    UnsupportedOperation 操作不支持。