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.

debugging

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.

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 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
AssociatedInstanceId	string	No	The ID of the instance that is assigned the IPv6 address.	i-2ze72wuqj4y3jl4f****
AssociatedInstanceType	string	No	The type of the instance that is assigned the IPv6 address. Set the value to EcsInstance, which specifies an Elastic Compute Service (ECS) instance in a virtual private cloud (VPC). This is the default value.	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****
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return per page. Maximum value: 50. Default value: 10.	10
IncludeReservationData	boolean	No	Specifies whether to return information about pending orders. Valid values: false (default) true	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	object []	The details about the IPv6 addresses.
VpcId	string	The ID of the VPC to which the IPv6 address belongs.	vpc-bp15zckdt37pq72zv****
Status	string	The status of the IPv6 address. Valid values: 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
AssociatedInstanceType	string	The type of the instance that is assigned the IPv6 address.	EcsInstance
AssociatedInstanceId	string	The ID of the instance that is assigned the IPv6 address.	i-2ze72wuqj4y3jl4f****
NetworkType	string	The type of communication supported by the IPv6 address. Valid values: Private Public	Private
Ipv6Address	string	The IPv6 address of the instance.	2408:XXXX:153:3921:851c:c435:7b12:1c5f
Ipv6Isp	string	The service provider 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 maximum bandwidth value of the IPv6 address. If the IPv6 address is associated with an EIP bandwidth plan, the value of RealBandwidth is the maximum bandwidth value of the EIP bandwidth plan. If the IPv6 address is not associated with an EIP bandwidth plan, the value of RealBandwidth is the maximum bandwidth value of the Internet bandwidth of the IPv6 address. If the IPv6 address is not associated with an EIP bandwidth plan or an Internet bandwidth plan, the values of RealBandwidth and Bandwidth are both 0.	5
Ipv6InternetBandwidth	object	The information about the Internet bandwidth of the IPv6 address.
InternetChargeType	string	The billing method of the Internet bandwidth of the IPv6 address. Valid values: PayByTraffic: pay-by-data-transfer PayByBandwidth: pay-by-bandwidth	PayByTraffic
BusinessStatus	string	The status of the Internet bandwidth of the IPv6 address. Valid values: Normal FinancialLocked SecurityLocked	Normal
Bandwidth	integer	The exclusive Internet bandwidth of the IPv6 address. Unit: Mbit/s.	5
Ipv6InternetBandwidthId	string	The instance ID of the Internet bandwidth of the IPv6 address.	ipv6bw-hp3b35oq1fj50kbv****
InstanceChargeType	string	The billing method of the Internet bandwidth of the IPv6 address. Only PostPaid may be returned, which indicates the pay-as-you-go billing method.	PostPaid
HasReservationData	boolean	Indicates whether renewal data is included. false true This parameter returns true only if 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: pay-by-data-transfer PayByBandwidth: pay-by-bandwidth	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 took 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

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.Ipv6Address	%s	-
400	IllegalParam.Ipv6AddressId	%s	-
400	IllegalParam.NetworkType	%s	-
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The specified region ID does not exist.

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

Change history

Change time

Summary of changes

Operation

2023-05-29

The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.

see changesets

Change item	Change content
Error Codes	The error codes of the API operation change.
	delete Error Codes: 400
	delete Error Codes: 404
Input Parameters	The input parameters of the API operation change.
	Added Input Parameters: IncludeReservationData
Output Parameters	The response structure of the API operation changes.