DescribeIpv6Addresses - - Alibaba Cloud ドキュメントセンター

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 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 (,).
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. 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://`.
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 Public
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 page number. Default value: 1.
PageSize	Integer	No	10	The number of entries to return per page. Maximum value: 50. Default value: 10.
Action	String	Yes	DescribeIpv6Addresses	The operation that you want to perform. Set the value to DescribeIpv6Addresses.
IncludeReservationData	Boolean	No	false	Specifies whether to return information about pending orders. Valid values: false (default) true

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 request ID.
PageNumber	Integer	1	The number of the returned page. Default value: 1.
TotalCount	Integer	2	The total 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 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 Public
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 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.
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 FinancialLocked SecurityLocked
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. Only PostPaid may be returned, which indicates the pay-as-you-go billing method.
HasReservationData	Boolean	false	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.
ReservationInternetChargeType	String	PayByTraffic	The metering method that is used after the renewal takes effect. PayByTraffic: pay-by-data-transfer PayByBandwidth: pay-by-bandwidth
ReservationOrderType	String	RENEW	The type of the renewal order. Only RENEW may be returned, which indicates that the order is placed for service renewal.
ReservationActiveTime	String	2021-05-23T16:00:00Z	The time when the renewal takes effect. The time is displayed in `YYYY-MM-DDThh:mm:ssZ` format.
ReservationBandwidth	Long	12	The maximum bandwidth after the renewal takes effect. Unit: Mbit/s.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-huhehaote
&Ipv6AddressId=ipv6-2zen5j4axcp5l5qyy****
&Ipv6Address=2408:XXXX:153:3921:851c:c435:7b12:1c5f
&Name=test
&AssociatedInstanceId=i-2ze72wuqj4y3jl4f****
&AssociatedInstanceType=EcsInstance
&NetworkType=Private
&VpcId=vpc-bp15zckdt37pq72zv****
&VSwitchId=vsw-25navfgbue4g****
&Ipv6InternetBandwidthId=ipv6bw-uf6hcyzu65v98v3du****
&PageNumber=1
&PageSize=10
&Action=DescribeIpv6Addresses
&IncludeReservationData=false
&Common request parameters

Sample success responses

XML format

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

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

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "AA4486A8-B6AE-469E-AB09-820EF8ECFA2B",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "Ipv6Addresses" : {
    "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


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

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