DescribeIpv6Addresses - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries IPv6 addresses in a region.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:DescribeIpv6Addresses	list	Ipv6InternetBandwidth `acs:vpc:{#regionId}:{#accountId}:vpc/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	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
Ipv6AddressId	string	No	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****
Ipv6Address	string	No	The IPv6 address that you want to query.	2408:XXXX:153:3921:851c:c435:7b12:1c5f
Name	string	No	The name of the IPv6 address that you want to query. The name must be 0 to 128 characters in length and cannot start with `http://` or `https://`.	test
AddressType	string	No	The type of IP address. Valid values: IPv6Address (default): indicates an IPv6 instance used to query a single IPv6 address. IPv6Prefix: indicates an IPv6 instance used to query prefix CIDR blocks.	IPv6Address
AssociatedInstanceId	string	No	The ID of the instance that is assigned the IPv6 address.	i-2ze72wuqj4y3jl4f****
AssociatedInstanceType	string	No	The type of instance associated with the IPv6 address. Valid values: EcsInstance: Elastic Compute Service (ECS) instance in a virtual private cloud (VPC) NetworkInterface: secondary elastic network interface (ENI)	EcsInstance
NetworkType	string	No	The type of communication supported by the IPv6 address. Valid values: Private Public	Private
VpcId	string	No	The ID of the VPC to which the IPv6 address belongs.	vpc-bp15zckdt37pq72zv****
VSwitchId	string	No	The ID of the vSwitch to which the IPv6 address belongs.	vsw-25navfgbue4g****
Ipv6InternetBandwidthId	string	No	The ID of the Internet bandwidth that you purchased for the IPv6 address.	ipv6bw-uf6hcyzu65v98v3du****
IncludeReservationData	boolean	No	Specifies whether to return information about pending orders. Valid values: false (default) true	false
ResourceGroupId	string	No	The ID of the resource group to which the IPv6 gateway belongs.	rg-bp67acfmxazb4ph****
Tag	array<object>	No	The tag list.
	object	No	The tag list.
Key	string	No	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
Value	string	No	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
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Maximum value: 50. Default value: 10.	10
ServiceManaged	boolean	No	Indicates whether the instance is managed. Valid values: true false If you do not specify this parameter, all instances are queried.	false

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Maximum value: 50. Default value: 10.	10
RequestId	string	The request ID.	AA4486A8-B6AE-469E-AB09-820EF8ECFA2B
PageNumber	integer	The page number of the returned page. Default value: 1.	1
TotalCount	integer	The number of returned entries.	2
Ipv6Addresses	array<object>	The details of the IPv6 address.
Ipv6Address	object
VpcId	string	The ID of the VPC to which the IPv6 address belongs.	vpc-bp15zckdt37pq72zv****
Status	string	The status of the IPv6 address. Pending Available	Available
Ipv6AddressId	string	The ID of the IPv6 address.	ipv6-2zen5j4axcp5l5qyy****
AllocationTime	string	The time when the IPv6 address was created.	2020-12-20T14:56:09Z
Ipv6AddressName	string	The name of the IPv6 address.	test
Ipv6AddressDescription	string	The description of the IPv6 address.	test
AssociatedInstanceType	string	The type of instance associated with the IPv6 address.	EcsInstance
AssociatedInstanceId	string	The ID of the instance associated with the IPv6 address.	i-2ze72wuqj4y3jl4f****
NetworkType	string	The type of connection supported by the IPv6 address. Valid values: Private Public	Private
Ipv6Address	string	The IPv6 address.	2408:XXXX:153:3921:851c:c435:7b12:1c5f
AddressType	string	The type of IPv6 address. Valid values: IPv6Address (default): indicates a single IPv6 IP. IPv6Prefix: indicates IPv6 CIDR.	IPv6Address
Ipv6Isp	string	The ISP of the IPv6 address. Valid values: BGP (default) ChinaMobile ChinaUnicom ChinaTelecom	BGP
VSwitchId	string	The ID of the vSwitch to which the IPv6 address belongs.	vsw-25navfgbue4g****
Ipv6GatewayId	string	The ID of the IPv6 gateway to which the IPv6 address belongs.	ipv6gw-2zewg0l66s73b4k2q****
RealBandwidth	integer	The peak bandwidth of the IPv6 address.	5
Ipv6InternetBandwidth	object	The Internet bandwidth of the IPv6 address.
InternetChargeType	string	The billing method of the Internet bandwidth of the IPv6 address. Valid values: PayByTraffic PayByBandwidth	PayByTraffic
BusinessStatus	string	The status of the Internet bandwidth of the IPv6 address. Valid values: Normal FinancialLocked SecurityLocked	Normal
Bandwidth	integer	The dedicated Internet bandwidth of the IPv6 address. Unit: Mbit/s.	5
Ipv6InternetBandwidthId	string	The Internet bandwidth ID of the IPv6 address.	ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeType	string	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
HasReservationData	boolean	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
ReservationInternetChargeType	string	The metering method that is used after the renewal takes effect. PayByTraffic PayByBandwidth	PayByTraffic
ReservationOrderType	string	The type of the renewal order. Only RENEW may be returned, which indicates that the order is placed for service renewal.	RENEW
ReservationActiveTime	string	The time when the renewal takes effect. The time is displayed in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-05-23T16:00:00Z
ReservationBandwidth	long	The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.	12
ResourceGroupId	string	The ID of the resource group to which the IPv6 gateway belongs.	rg-bp67acfmxazb4ph****
Tags	array<object>	The tag list.
Tag	object	The tag list.
Key	string	The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The tag value. 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
ServiceManaged	integer	Indicates whether the instance is managed. Valid values: 1: yes 0: no	1

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.Ipv6Address	The param of %s is illegal.	The IPv6 address is invalid.
400	IllegalParam.NetworkType	The param of %s is illegal.	Invalid NetworkType value.
400	IllegalParam.AddressType	The specified AddressType is illegal.	The specified input AddressType is illegal.

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

Change history

Change time	Summary of changes	Operation
2025-01-22	The Error code has changed	View Change Details
2024-08-08	The Error code has changed	View Change Details
2024-06-28	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2024-03-14	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-05-29	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details