文档

DescribeIpv6Addresses - 查询IPv6地址列表

更新时间:
一键部署

查询IPv6地址列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeIpv6AddressesList
  • Ipv6InternetBandwidth
    acs:vpc:{#regionId}:{#accountId}:vpc/*

请求参数

名称类型必填描述示例值
RegionIdstring

要查询的 IPv6 地址所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-huhehaote
Ipv6AddressIdstring

要查询的 IPv6 地址 ID。每次调用最多可以输入 20 个 IPv6 地址 ID,以半角逗号(,)分隔。

ipv6-2zen5j4axcp5l5qyy****
Ipv6Addressstring

要查询的 IPv6 地址。

2408:XXXX:153:3921:851c:c435:7b12:1c5f
Namestring

要查询的 IPv6 地址的名称。

名称长度为 2~128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

test
AssociatedInstanceIdstring

要查询的 IPv6 地址关联的实例 ID。

i-2ze72wuqj4y3jl4f****
AssociatedInstanceTypestring

要查询的 IPv6 地址所关联的实例类型,取值:

  • EcsInstance:VPC 类型的 ECS。
  • NetworkInterface:辅助弹性网卡 ENI。
EcsInstance
NetworkTypestring

要查询的 IPv6 地址的通信能力类型,取值:

  • Private:私网通信类型。

  • Public:公网通信类型。

Private
VpcIdstring

要查询的 IPv6 地址所在的 VPC ID。

vpc-bp15zckdt37pq72zv****
VSwitchIdstring

要查询的 IPv6 地址所在的交换机 ID。

vsw-25navfgbue4g****
Ipv6InternetBandwidthIdstring

开通公网带宽后,要查询的 IPv6 地址对应的公网带宽实例 ID。

ipv6bw-uf6hcyzu65v98v3du****
IncludeReservationDataboolean

是否包含未生效的订购数据,取值:

  • false(默认值):不包含未生效的订购数据。

  • true:包含未生效的订购数据。

false
ResourceGroupIdstring

IPv6 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagarray<object>

标签列表。列表元素最大数量:20。

object

资源的标签集合。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。一旦传入该值,可以为空字符串。

一个标签值最多支持 128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-),不能以aliyunacs:开头,不能包含http://或者https://

yunke
PageNumberinteger

列表的页码,默认值:1

1
PageSizeinteger

分页查询时每页的行数,最大值:50;默认值:10

10
ServiceManagedboolean

是否为托管实例。取值:

  • true:是托管实例。
  • false:不是托管实例。

不填默认查询所有实例。

false

返回参数

名称类型描述示例值
object
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10
RequestIdstring

请求 ID。

AA4486A8-B6AE-469E-AB09-820EF8ECFA2B
PageNumberinteger

列表的页码,默认值为 1

1
TotalCountinteger

列表条目数。

2
Ipv6Addressesarray<object>

IPv6 地址的详细信息。

object

Ipv6 地址的详细信息。

VpcIdstring

IPv6 地址所在的 VPC ID。

vpc-bp15zckdt37pq72zv****
Statusstring

IPv6 地址的状态,取值:

  • Pending:配置中。

  • Available:可用。

Available
Ipv6AddressIdstring

IPv6 地址的实例 ID。

ipv6-2zen5j4axcp5l5qyy****
AllocationTimestring

IPv6 地址的创建时间。

2020-12-20T14:56:09Z
Ipv6AddressNamestring

IPv6 地址的实例名称。

test
Ipv6AddressDescriptionstring

IPv6 地址的实例描述。

test
AssociatedInstanceTypestring

IPv6 地址关联的实例类型。

EcsInstance
AssociatedInstanceIdstring

IPv6 地址关联的实例 ID。

i-2ze72wuqj4y3jl4f****
NetworkTypestring

IPv6 地址的通信能力类型,取值:

  • Private:私网通信类型。

  • Public:公网通信类型 。

Private
Ipv6Addressstring

IPv6 地址。

2408:XXXX:153:3921:851c:c435:7b12:1c5f
AddressTypestring

IPv6 地址的类型,取值:

  • IPv6Address(默认值):代表当前实例是单个 IPv6 IP。
  • IPv6Prefix:代表当前实例是 IPv6 Cidr。
IPv6Address
Ipv6Ispstring

IPv6 地址的服务运营商,取值:

  • BGP(默认值):阿里云 BGP IPv6。
  • ChinaMobile:中国移动(单线)。
  • ChinaUnicom:中国联通(单线)。
  • ChinaTelecom:中国电信(单线)。
BGP
VSwitchIdstring

IPv6 地址所在的交换机的 ID。

vsw-25navfgbue4g****
Ipv6GatewayIdstring

IPv6 地址的所属 IPv6 网关实例 ID。

ipv6gw-2zewg0l66s73b4k2q****
RealBandwidthinteger

IPv6 地址的实际带宽峰值。

5
Ipv6InternetBandwidthobject

IPv6 地址的公网带宽信息。

InternetChargeTypestring

IPv6 地址的公网带宽的计费方式,取值:

  • PayByTraffic:按使用流量计费。
  • PayByBandwidth:按固定带宽计费。
  • PayByOld95:表示按传统 95 计费。IPv6 公网带宽默认不支持按传统 95 计费,如需使用,请联系客户经理申请。
PayByTraffic
BusinessStatusstring

IPv6 地址的公网带宽的商业状态,取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

  • SecurityLocked:安全锁定。

Normal
Bandwidthinteger

IPv6 地址的独享公网带宽,单位:Mbps。

5
Ipv6InternetBandwidthIdstring

IPv6 地址的公网带宽实例 ID。

ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeTypestring

IPv6 地址的公网带宽的付费方式,取值:

PostPaid:后付费。

PostPaid
HasReservationDataboolean

是否有续费数据。

  • false:无续费数据。

  • true:有续费数据。只有在入参 IncludeReservationDatatrue,且有未生效订购数据时才会为 true

false
ReservationInternetChargeTypestring

续费付费类型。

  • PayByTraffic:按使用流量计费。
  • PayByBandwidth:按固定带宽计费。
  • PayByOld95:按传统 95 计费。IPv6 公网带宽默认不支持按传统 95 计费,如需使用,请联系客户经理申请。
PayByTraffic
ReservationOrderTypestring

续费订单类型。取值:RENEW,表示续费订单。

RENEW
ReservationActiveTimestring

续费生效时间,格式为YYYY-MM-DDThh:mm:ssZ

2021-05-23T16:00:00Z
ReservationBandwidthlong

续费带宽。单位:Mbps。

12
ResourceGroupIdstring

IPv6 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsarray<object>

标签列表。

object

标签列表信息。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

标签的标签值。

标签值最多支持 128 个字符,可以为空字符串,不能以aliyunacs:开头,不能包含http://或者https://

一个标签键对应一个标签值。一次最多支持输入 20 个标签值。

yunke
ServiceManagedinteger

是否为托管实例。取值:

  • 1:是托管实例。

  • 0:不是托管实例。

1

示例

正常返回示例

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错误码错误信息描述
400IllegalParam.Ipv6AddressThe param of %s is illegal.您指定的ipv6地址非法,请检查您的输入是否正确
400IllegalParam.NetworkTypeThe param of %s is illegal.您输入的NetworkType非法,请检查您的输入是否正确

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-03-14OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2023-05-29OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情