1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(DescribeVpcIpv6Addresses)用于查询 VPC
IPv6
信息。
只能查询已使用的IPv6
信息,当查询未使用的IP时,本接口不会报错,但不会出现在返回结果里。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVpcIpv6Addresses。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | VPC 实例ID ,形如:vpc-f49l6u0z 。示例值:vpc-rkxd3pgh |
Ipv6Addresses.N | 否 | Array of String | IP 地址列表,批量查询单次请求最多支持10 个。示例值:["2402:4e00:1015:4a00::/56"] |
Offset | 否 | Integer | 偏移量,默认为0。 示例值:0 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 示例值:20 |
SubnetId | 否 | String | VPC下的子网ID。 示例值:subnet-hx8an9sr |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Ipv6AddressSet | Array of VpcIpv6Address | IPv6 地址列表。 |
TotalCount | Integer | IPv6 地址总数。示例值:6 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询VPC内IPv6地址列表
查询VPC内IPv6地址列表
输入示例
https://vpc.tencentcloudapi.com/?Action=DescribeVpcIpv6Addresses
&VpcId=vpc-rkxd3pgh
&<公共请求参数>
输出示例
{
"Response": {
"Ipv6AddressSet": [
{
"Ipv6Address": "2402:4e00:1000:101:0:8d1a:6c7b:c0e8",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-01 21:18:07"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d20:3e2:683",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-04 16:00:36"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d20:3f5:8b0f",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-04 16:00:48"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d24:30a5:d9f3",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-06 17:49:05"
},
{
"Ipv6Address": "2402:4e00:1000:101:0:8d2e:133c:e12c",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:101::/64",
"CreatedTime": "2019-03-11 15:45:07"
},
{
"Ipv6Address": "2402:4e00:1000:108:0:8d24:690c:59c6",
"Ipv6AddressType": "CVM",
"CidrBlock": "2402:4e00:1000:108::/64",
"CreatedTime": "2019-03-06 20:26:47"
}
],
"TotalCount": 6,
"RequestId": "ee464fec-e13e-401b-87f0-f93f047550c2"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
ResourceNotFound | 资源不存在。 |