All Products
Search
Document Center

Virtual Private Cloud:DescribeIpv6Addresses

Last Updated:Mar 04, 2024

Queries IPv6 addresses in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeIpv6AddressesList
  • Ipv6InternetBandwidth
    acs:vpc:{#regionId}:{#accountId}:vpc/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region in which you want to query IPv6 addresses. You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
Ipv6AddressIdstringNo

The ID of the IPv6 address that you want to query. You can enter at most 20 IPv6 address IDs in each API request. Separate IPv6 address IDs with commas (,).

ipv6-2zen5j4axcp5l5qyy****
Ipv6AddressstringNo

The IPv6 address that you want to query.

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

The name of the IPv6 address that you want to query.

The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

test
AssociatedInstanceIdstringNo

The ID of the instance that is assigned the IPv6 address.

i-2ze72wuqj4y3jl4f****
AssociatedInstanceTypestringNo

The type of instance associated with the IPv6 address. Valid values:

EcsInstance: Elastic Compute Service (ECS) instance in a virtual private cloud (VPC).

EcsInstance
NetworkTypestringNo

The type of communication supported by the IPv6 address. Valid values:

  • Private
  • Public
Private
VpcIdstringNo

The ID of the VPC to which the IPv6 address belongs.

vpc-bp15zckdt37pq72zv****
VSwitchIdstringNo

The ID of the vSwitch to which the IPv6 address belongs.

vsw-25navfgbue4g****
Ipv6InternetBandwidthIdstringNo

The ID of the Internet bandwidth that you purchased for the IPv6 address.

ipv6bw-uf6hcyzu65v98v3du****
IncludeReservationDatabooleanNo

Specifies whether to return information about pending orders. Valid values:

  • false (default)
  • true
false
ResourceGroupIdstringNo

The ID of the resource group to which the IPv6 gateway belongs.

rg-bp67acfmxazb4ph****
Tagobject []No

The tag list.

KeystringNo

The key of tag N. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

FinanceDept
ValuestringNo

The value of tag N.

The tag value can be up to 128 characters in length. It can be an empty string. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Each tag key corresponds to one tag value. You can specify at most 20 tag values at a time.

yunke
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return per page. Maximum value: 50. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page. Maximum value: 50. Default value: 10.

10
RequestIdstring

The request ID.

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

The page number of the returned page. Default value: 1.

1
TotalCountinteger

The number of returned entries.

2
Ipv6Addressesobject []

The details of the IPv6 address.

VpcIdstring

The ID of the VPC to which the IPv6 address belongs.

vpc-bp15zckdt37pq72zv****
Statusstring

The status of the IPv6 address.

  • Pending
  • Available
Available
Ipv6AddressIdstring

The ID of the IPv6 address.

ipv6-2zen5j4axcp5l5qyy****
AllocationTimestring

The time when the IPv6 address was created.

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

The name of the IPv6 address.

test
Ipv6AddressDescriptionstring

The description of the IPv6 address.

test
AssociatedInstanceTypestring

The type of instance associated with the IPv6 address.

EcsInstance
AssociatedInstanceIdstring

The ID of the instance associated with the IPv6 address.

i-2ze72wuqj4y3jl4f****
NetworkTypestring

The type of connection supported by the IPv6 address. Valid values:

  • Private
  • Public
Private
Ipv6Addressstring

The IPv6 address.

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

The ISP of the IPv6 address.

  • BGP (default)
  • ChinaMobile
  • ChinaUnicom
  • ChinaTelecom
BGP
VSwitchIdstring

The ID of the vSwitch to which the IPv6 address belongs.

vsw-25navfgbue4g****
Ipv6GatewayIdstring

The ID of the IPv6 gateway to which the IPv6 address belongs.

ipv6gw-2zewg0l66s73b4k2q****
RealBandwidthinteger

The peak bandwidth of the IPv6 address.

5
Ipv6InternetBandwidthobject

The Internet bandwidth of the IPv6 address.

InternetChargeTypestring

The billing method of the Internet bandwidth of the IPv6 address. Valid values:

  • PayByTraffic
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
BusinessStatusstring

The status of the Internet bandwidth of the IPv6 address. Valid values:

  • Normal
  • FinancialLocked
  • SecurityLocked
Normal
Bandwidthinteger

The dedicated Internet bandwidth of the IPv6 address. Unit: Mbit/s.

5
Ipv6InternetBandwidthIdstring

The Internet bandwidth ID of the IPv6 address.

ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeTypestring

The billing method of the Internet bandwidth of the IPv6 address. Valid values:

Only PostPaid may be returned, which indicates the pay-as-you-go billing method.

PostPaid
HasReservationDataboolean

Indicates whether renewal data is included. Valid values:

  • false
  • true true is returned only when IncludeReservationData is set to true and some orders have not taken effect.
false
ReservationInternetChargeTypestring

The metering method that is used after the renewal takes effect.

  • PayByTraffic
  • PayByBandwidth: pay-by-bandwidth
PayByTraffic
ReservationOrderTypestring

The type of the renewal order. Only RENEW may be returned, which indicates that the order is placed for service renewal.

RENEW
ReservationActiveTimestring

The time when the renewal took effect. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format.

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

The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.

12
ResourceGroupIdstring

The ID of the resource group to which the IPv6 gateway belongs.

rg-bp67acfmxazb4ph****
Tagsobject []

The tag list.

Keystring

The key of tag N. You can specify at most 20 tag keys. The tag key cannot be an empty string.

The tag key can be up to 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

FinanceDept
Valuestring

The value of tag N.

The tag value can be up to 128 characters in length. It can be an empty string. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Each tag key corresponds to one tag value. You can specify at most 20 tag values at a time.

yunke

Examples

Sample success responses

JSONformat

{
  "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",
        "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"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.Ipv6AddressThe param of %s is illegal.The IPv6 address is invalid.
400IllegalParam.NetworkTypeThe param of %s is illegal.Invalid NetworkType value.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-05-29The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: IncludeReservationData
Output ParametersThe response structure of the API has changed.