DescribeIpv6Addresses - API Reference| Alibaba Cloud Documentation Center

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
RegionId	String	Yes	cn-huhehaote	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.
Ipv6AddressId	String	No	ipv6-2zen5j4axcp5l5qyy****	The IDs of the IPv6 addresses that you want to query. You can enter at most 20 IPv6 IDs in each API request. Separate IPv6 IDs with commas (,).
Ipv6Address	String	No	2408:XXXX:153:3921:851c:c435:7b12:1c5f	The IPv6 address that you want to query.
Name	String	No	test	The name of the IPv6 address that you want to query.
AssociatedInstanceId	String	No	i-2ze72wuqj4y3jl4f****	The ID of the instance that is assigned the IPv6 address.
AssociatedInstanceType	String	No	EcsInstance	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.
NetworkType	String	No	Private	The type of communication supported by the IPv6 address. Valid values: Private: communication within private networks Public: communication over the Internet
VpcId	String	No	vpc-bp15zckdt37pq72zv****	The ID of the VPC to which the IPv6 address belongs.
VSwitchId	String	No	vsw-25navfgbue4g****	The ID of the vSwitch to which the IPv6 address belongs.
Ipv6InternetBandwidthId	String	No	ipv6bw-uf6hcyzu65v98v3du****	The ID of the Internet bandwidth that you purchased for the IPv6 address.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
PageSize	Integer	No	10	The number of entries returned per page. Maximum value: 50. Default value: 10.
Action	String	Yes	DescribeIpv6Addresses	The operation that you want to perform. Set the value to DescribeIpv6Addresses.

Response parameters


Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries returned per page. Maximum value: 50. Default value: 10.
RequestId	String	AA4486A8-B6AE-469E-AB09-820EF8ECFA2B	The ID of the request.
PageNumber	Integer	1	The page number of the returned page. Default value: 1.
TotalCount	Integer	2	The number of entries returned.
Ipv6Addresses	Array of Ipv6Address		The details about the IPv6 addresses.
Ipv6Address
VpcId	String	vpc-bp15zckdt37pq72zv****	The ID of the VPC to which the IPv6 address belongs.
Status	String	Available	The status of the IPv6 address. Valid values: Pending: being configured Available: available
Ipv6AddressId	String	ipv6-2zen5j4axcp5l5qyy****	The ID of the IPv6 address.
AllocationTime	String	2020-12-20T14:56:09Z	The time when the IPv6 address was created.
Ipv6AddressName	String	test	The name of the IPv6 address.
AssociatedInstanceType	String	EcsInstance	The type of the instance that is assigned the IPv6 address.
AssociatedInstanceId	String	i-2ze72wuqj4y3jl4f****	The ID of the instance that is assigned the IPv6 address.
NetworkType	String	Private	The type of communication supported by the IPv6 address. Valid values: Private: communication within private networks Public: communication over the Internet
Ipv6Address	String	2408:XXXX:153:3921:851c:c435:7b12:1c5f	The IPv6 address.
Ipv6Isp	String	BGP	The service provider of the IPv6 address. Valid values: BGP (default): Alibaba Cloud Border Gateway Protocol (BGP) ChinaMobile: China Mobile (single ISP) ChinaUnicom: China Unicom (single ISP) ChinaTelecom: China Telecom (single ISP)
VSwitchId	String	vsw-25navfgbue4g****	The ID of the vSwitch to which the IPv6 address belongs.
Ipv6GatewayId	String	ipv6gw-2zewg0l66s73b4k2q****	The ID of the IPv6 gateway to which the IPv6 address belongs.
RealBandwidth	Integer	5	The peak bandwidth value of the IPv6 address. If the IPv6 address is associated with an EIP bandwidth plan, the value of RealBandwidth is the peak 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 peak 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.
Ipv6InternetBandwidth	Object		The information about the Internet bandwidth of the IPv6 address.
InternetChargeType	String	PayByTraffic	The billing method of the Internet bandwidth of the IPv6 address. Valid values: PayByTraffic: pay-by-data-transfer PayByBandwidth: pay-by-bandwidth
BusinessStatus	String	Normal	The status of the Internet bandwidth of the IPv6 address. Valid values: Normal: normal FinacialLocked: locked due to overdue payments SecurityLocked: locked due to security reasons
Bandwidth	Integer	5	The exclusive Internet bandwidth of the IPv6 address. Unit: Mbit/s.
Ipv6InternetBandwidthId	String	ipv6bw-hp3b35oq1fj50kbv****	The instance ID of the Internet bandwidth of the IPv6 address.
InstanceChargeType	String	PostPaid	The billing method of the Internet bandwidth of the IPv6 address. Valid values: PostPaid: pay-as-you-go

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeIpv6Addresses
&RegionId=cn-huhehaote
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeIpv6AddressesResponse> 
<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<RequestId>AA4486A8-B6AE-469E-AB09-820EF8ECFA2B</RequestId>
<PageNumber>1</PageNumber>
<Ipv6Addresses>
    <Ipv6Address>
        <AllocationTime>2020-12-20T14:56:09Z</AllocationTime>
        <Status>Available</Status>
        <Ipv6Isp>BGP</Ipv6Isp>
        <AssociatedInstanceId>i-2ze72wuqj4y3jl4f****</AssociatedInstanceId>
        <VpcId>vpc-bp15zckdt37pq72zv****</VpcId>
        <NetworkType>Private</NetworkType>
        <VSwitchId>vsw-25navfgbue4g****</VSwitchId>
        <Ipv6AddressId>ipv6-2zen5j4axcp5l5qyy****</Ipv6AddressId>
        <Ipv6GatewayId>ipv6gw-2zewg0l66s73b4k2q****</Ipv6GatewayId>
        <RealBandwidth>5</RealBandwidth>
        <AssociatedInstanceType>EcsInstance</AssociatedInstanceType>
        <Ipv6Address>2408:XXXX:153:3921:851c:c435:7b12:1c5f</Ipv6Address>
        <Ipv6AddressName>test</Ipv6AddressName>
        <Ipv6InternetBandwidth>
            <InstanceChargeType>PostPaid</InstanceChargeType>
            <Bandwidth>5</Bandwidth>
            <Ipv6InternetBandwidthId>ipv6bw-hp3b35oq1fj50kbv****</Ipv6InternetBandwidthId>
            <BusinessStatus>Normal</BusinessStatus>
            <InternetChargeType>PayByTraffic</InternetChargeType>
        </Ipv6InternetBandwidth>
    </Ipv6Address>
</Ipv6Addresses>
</DescribeIpv6AddressesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 2,
  "PageSize" : 10,
  "RequestId" : "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
  "PageNumber" : 1,
  "Ipv6Addresses" : {
    "Ipv6Address" : {
      "AllocationTime" : "2020-12-20T14:56:09Z",
      "Status" : "Available",
      "Ipv6Isp" : "BGP",
      "AssociatedInstanceId" : "i-2ze72wuqj4y3jl4f****",
      "VpcId" : "vpc-bp15zckdt37pq72zv****",
      "NetworkType" : "Private",
      "VSwitchId" : "vsw-25navfgbue4g****",
      "Ipv6AddressId" : "ipv6-2zen5j4axcp5l5qyy****",
      "Ipv6GatewayId" : "ipv6gw-2zewg0l66s73b4k2q****",
      "RealBandwidth" : 5,
      "AssociatedInstanceType" : "EcsInstance",
      "Ipv6Address" : "2408:XXXX:153:3921:851c:c435:7b12:1c5f",
      "Ipv6AddressName" : "test",
      "Ipv6InternetBandwidth" : {
        "InstanceChargeType" : "PostPaid",
        "Bandwidth" : 5,
        "Ipv6InternetBandwidthId" : "ipv6bw-hp3b35oq1fj50kbv****",
        "BusinessStatus" : "Normal",
        "InternetChargeType" : "PayByTraffic"
      }
    }
  }
}

Error codes


HttpCode	Error code	Error message	Description
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	The error message returned because the specified region ID does not exist.

For a list of error codes, visit the API Error Center.