1. 接口描述
接口请求域名: ecm.tencentcloudapi.com 。
该接口(DescribeRegionIpv6Addresses)用于查询ECM地域之下的IPV6地址信息。
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeRegionIpv6Addresses。 | 
| Version | 是 | String | 公共参数,本接口取值:2019-07-19。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| EcmRegion | 是 | String | ECM 地域,为空时返回所有地域的IPv6地址。 示例值:ap-qingdao-ecm | 
| Filters.N | 否 | Array of Filter | 详细的过滤条件如下: address-id - String - 是否必填:否 - (过滤条件)按照 EIP 的 ID 过滤。 address-ip - String - 是否必填:否 - (过滤条件)按照 EIP 的 IP 地址过滤。 network-interface-id - String - 是否必填:否 - (过滤条件)按照弹性网卡的唯一ID过滤。 instance-id - String - 是否必填:否 - (过滤条件)按照 EIP 所绑定的实例 ID 过滤。 vpc-id - String - 是否必填:否 - (过滤条件)按照 EIP 所在 VPC 的 ID 进行过滤。 address-isp - String - 是否必填:否 - (过滤条件)按照 EIP 的运营商进行过滤。 address-status - String - 是否必填:否 - (过滤条件)按照 EIP 的状态信息进行过滤。 | 
| Offset | 否 | Integer | 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 示例值:0 | 
| Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。 示例值:0 | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| TotalCount | Integer | 符合条件的 IPV6 数量。 示例值:1 | 
| AddressSet | Array of Address | IPV6 详细信息列表。 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 根据Ip6AddressIds查询地域下的IPV6信息
输入示例
https://ecm.tencentcloudapi.com/?Action=DescribeRegionIpv6Addresses
&EcmRegion=ap-qingdao-ecm
&<公共请求参数>输出示例
{
    "Response": {
        "TotalCount": 1,
        "AddressSet": [
            {
                "AddressId": "eip-lrhy2lpe",
                "AddressIp": "2402:4e00:1000:2d00:0:8f3f:6:9895",
                "AddressStatus": "BIND",
                "InstanceId": "ein-190087yw",
                "NetworkInterfaceId": "eni-rw4fh3gn",
                "IsArrears": false,
                "CreatedTime": "2020-01-13T04:09:52Z",
                "Bandwidth": 6,
                "IsEipDirectConnection": true,
                "PrivateAddressIp": "",
                "AddressName": "name",
                "PayMode": "0",
                "CascadeRelease": true,
                "InternetServiceProvider": "CTCC",
                "AddressType": "",
                "IsBlocked": true
            }
        ],
        "RequestId": "bfe06911-32f5-4862-9d42-6bb4954dcb59"
    }
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.InternalOperationFailure | 内部操作错误。 | 
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 | 
| InvalidParameterValue | 参数取值错误。 | 
| InvalidParameterValue.InvalidEcmRegion | 地域参数不合法。 | 
| InvalidParameterValue.Malformed | 入参格式不合法。 | 
| InvalidParameterValue.UnsupportedRegion | 不支持该区域。 | 
| InvalidParameterValue.UserNotSupportIPv6 | 用户不支持ipv6。 | 
| MissingParameter | 缺少参数错误。 | 
| ResourceInsufficient | 资源不足。 | 
| ResourceNotFound | 资源不存在。 | 
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |