Queries IPv6 gateways in a specified region.

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 region ID of the IPv6 gateway.

Note IPv6 is supported in the following regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), China (Hong Kong), Philippines (Manila), Singapore (Singapore), US (Virginia), and Germany (Frankfurt).
Ipv6GatewayId String No ipv6gw-hp3rwmtmfhgis****

The ID of the IPv6 gateway.

VpcId String No vpc-123sedrfswd23****

The ID of the virtual private cloud (VPC) to which the IPv6 gateway belongs.

Name String No ipv6GW

The name of the IPv6 gateway.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

Action String Yes DescribeIpv6Gateways

The operation that you want to perform. Set the value to DescribeIpv6Gateways.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 2

The total number of entries returned.

Ipv6Gateways Array of Ipv6Gateway

The details about the IPv6 gateways.

Ipv6Gateway
CreationTime String 2020-12-20T14:51:23Z

The time when the IPv6 gateway was created.

Status String Available

The status of the IPv6 gateway. Valid values:

  • Pending: being configured
  • Available: available
VpcId String vpc-123sedrfswd23****

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

Spec String Small

The edition of the IPv6 gateway. Valid values:

  • Small (default): Free Edition
  • Middle: Enterprise Edition
  • Large: Enhanced Enterprise Edition
Description String descriptionforIPv6GW

The description of the IPv6 gateway.

Ipv6GatewayId String ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****

The ID of the IPv6 gateway.

ExpiredTime String 2021-12-20T14:51:23Z

The time when the IPv6 gateway expires.

BusinessStatus String Normal

The status of the IPv6 gateway. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
Name String ipv6GW

The name of the IPv6 gateway.

InstanceChargeType String PostPaid

The billing method of the IPv6 gateway.

The value is set to PostPaid. This value indicates the pay-as-you-go billing method.

RegionId String cn-huhehaote

The region ID of the IPv6 gateway.

Examples

Sample requests

https://vpc.aliyuncs.com/?Action=DescribeIpv6Gateways
&RegionId=cn-huhehaote
&Common request parameters

Sample success responses

XML format

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

<DescribeIpv6GatewaysResponse>
    <PageSize>10</PageSize>
    <RequestId>E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>2</TotalCount>
    <Ipv6Gateways>
        <CreationTime>2020-12-20T14:51:23Z</CreationTime>
        <Status>Available</Status>
        <VpcId>vpc-123sedrfswd23****</VpcId>
        <Spec>Small</Spec>
        <Description>descriptionforIPv6GW</Description>
        <Ipv6GatewayId>ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****</Ipv6GatewayId>
        <ExpiredTime>2021-12-20T14:51:23Z</ExpiredTime>
        <BusinessStatus>Normal</BusinessStatus>
        <Name>ipv6GW</Name>
        <InstanceChargeType>PostPaid</InstanceChargeType>
        <RegionId>cn-huhehaote</RegionId>
    </Ipv6Gateways>
</DescribeIpv6GatewaysResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
  "PageNumber" : 1,
  "TotalCount" : 2,
  "Ipv6Gateways" : [ {
    "CreationTime" : "2020-12-20T14:51:23Z",
    "Status" : "Available",
    "VpcId" : "vpc-123sedrfswd23****",
    "Spec" : "Small",
    "Description" : "descriptionforIPv6GW",
    "Ipv6GatewayId" : "ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****",
    "ExpiredTime" : "2021-12-20T14:51:23Z",
    "BusinessStatus" : "Normal",
    "Name" : "ipv6GW",
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-huhehaote"
  } ]
}

Error codes

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