查询IPv6地址列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeIpv6Addresses | list | *Ipv6InternetBandwidth acs:vpc:{#regionId}:{#accountId}:vpc/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 要查询的 IPv6 地址所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-huhehaote |
Ipv6AddressId | string | 否 | 要查询的 IPv6 地址 ID。每次调用最多可以输入 20 个 IPv6 地址 ID,以半角逗号(,)分隔。 | ipv6-2zen5j4axcp5l5qyy**** |
Ipv6Address | string | 否 | 要查询的 IPv6 地址。 | 2408:XXXX:153:3921:851c:c435:7b12:1c5f |
Name | string | 否 | 要查询的 IPv6 地址的名称。 名称长度为 0-128 个字符,不能以 | test |
AddressType | string | 否 | IPv6 地址的类型,取值:
| IPv6Address |
AssociatedInstanceId | string | 否 | 要查询的 IPv6 地址关联的实例 ID。 | i-2ze72wuqj4y3jl4f**** |
AssociatedInstanceType | string | 否 | 要查询的 IPv6 地址所关联的实例类型,取值:
| EcsInstance |
NetworkType | string | 否 | 要查询的 IPv6 地址的通信能力类型,取值:
| Private |
VpcId | string | 否 | 要查询的 IPv6 地址所在的 VPC ID。 | vpc-bp15zckdt37pq72zv**** |
VSwitchId | string | 否 | 要查询的 IPv6 地址所在的交换机 ID。 | vsw-25navfgbue4g**** |
Ipv6InternetBandwidthId | string | 否 | 开通公网带宽后,要查询的 IPv6 地址对应的公网带宽实例 ID。 | ipv6bw-uf6hcyzu65v98v3du**** |
IncludeReservationData | boolean | 否 | 是否包含未生效的订购数据,取值:
| false |
ResourceGroupId | string | 否 | IPv6 网关所属的资源组 ID。 | rg-bp67acfmxazb4ph**** |
Tag | array<object> | 否 | 标签列表。列表元素最大数量:20。 | |
object | 否 | 资源的标签集合。 | ||
Key | string | 否 | 资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。 一个标签键最多支持 128 个字符,不能以 | FinanceDept |
Value | string | 否 | 资源的标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。 一个标签值最多支持 128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以 | yunke |
PageNumber | integer | 否 | 列表的页码,默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时每页的行数,最大值:50;默认值:10。 | 10 |
ServiceManaged | boolean | 否 | 是否为托管实例。取值:
不填默认查询所有实例。 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
"PageNumber": 1,
"TotalCount": 2,
"Ipv6Addresses": {
"Ipv6Address": [
{
"VpcId": "vpc-bp15zckdt37pq72zv****",
"Status": "Available",
"Ipv6AddressId": "ipv6-2zen5j4axcp5l5qyy****",
"AllocationTime": "2020-12-20T14:56:09Z",
"Ipv6AddressName": "test",
"Ipv6AddressDescription": "test",
"AssociatedInstanceType": "EcsInstance",
"AssociatedInstanceId": "i-2ze72wuqj4y3jl4f****",
"NetworkType": "Private",
"Ipv6Address": "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
"AddressType": "IPv6Address",
"Ipv6Isp": "BGP",
"VSwitchId": "vsw-25navfgbue4g****",
"Ipv6GatewayId": "ipv6gw-2zewg0l66s73b4k2q****",
"RealBandwidth": 5,
"Ipv6InternetBandwidth": {
"InternetChargeType": "PayByTraffic",
"BusinessStatus": "Normal",
"Bandwidth": 5,
"Ipv6InternetBandwidthId": "ipv6bw-hp3b35oq1fj50kbv****",
"InstanceChargeType": "PostPaid",
"HasReservationData": false,
"ReservationInternetChargeType": "PayByTraffic",
"ReservationOrderType": "RENEW",
"ReservationActiveTime": "2021-05-23T16:00:00Z",
"ReservationBandwidth": 12
},
"ResourceGroupId": "rg-bp67acfmxazb4ph****",
"Tags": {
"Tag": [
{
"Key": "FinanceDept",
"Value": "yunke"
}
]
},
"ServiceManaged": 1
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.Ipv6Address | The param of %s is illegal. | 您指定的ipv6地址非法,请检查您的输入是否正确 |
400 | IllegalParam.NetworkType | The param of %s is illegal. | 您输入的NetworkType非法,请检查您的输入是否正确 |
400 | IllegalParam.AddressType | The specified AddressType is illegal. | 指定的入参AddressType非法 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-08 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-06-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2024-03-14 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-05-29 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |