DescribeIpv6Gateways - - 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 region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the most recent region list.
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. The name must be 2 to 256 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter and cannot start with `http://` or `https://`.
PageNumber	Integer	No	1	The page number.
PageSize	Integer	No	10	The number of entries per page.
Action	String	Yes	DescribeIpv6Gateways	The operation that you want to perform. Set the value to DescribeIpv6Gateways.
ResourceGroupId	String	No	rg-bp67acfmxazb4ph****	The ID of the resource group.
Tags.N.Key	String	No	FinanceDept	The key of tag N to add to the resource. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be at most 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.
Tags.N.Value	String	No	FinanceJoshua	The value of tag N to add to the resource. You can specify at most 20 tag values. The tag value can be an empty string. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun`.

Response parameters

Parameter	Type	Example	Description
PageSize	Integer	10	The number of entries per page.
RequestId	String	E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD	The request ID.
PageNumber	Integer	1	The page number.
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 Available
VpcId	String	vpc-123sedrfswd23****	The ID of the VPC to which the IPv6 gateway belongs.
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 state of the IPv6 gateway. Valid values: Normal FinancialLocked
Name	String	ipv6GW	The name of the IPv6 gateway.
InstanceChargeType	String	PostPaid	The billing method of the IPv6 gateway. Only PostPaid may be returned, which indicates that the IPv6 gateway uses the pay-as-you-go billing method.
RegionId	String	cn-huhehaote	The region ID of the IPv6 gateway.
ResourceGroupId	String	rg-bp67acfmxazb4ph****	The ID of the resource group.
Tags	Array of Tag		The tags added to the resource.
Tag
Key	String	FinanceDept	The key of tag N.
Value	String	FinanceJoshua	The value of tag N.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-huhehaote
&Ipv6GatewayId=ipv6gw-hp3rwmtmfhgis****
&VpcId=vpc-123sedrfswd23****
&Name=ipv6GW
&PageNumber=1
&PageSize=10
&Action=DescribeIpv6Gateways
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&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>
        <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>
        <ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
        <Tags>
            <Key>FinanceDept</Key>
            <Value>FinanceJoshua</Value>
        </Tags>
    </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****",
    "Description" : "descriptionforIPv6GW",
    "Ipv6GatewayId" : "ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****",
    "ExpiredTime" : "2021-12-20T14:51:23Z",
    "BusinessStatus" : "Normal",
    "Name" : "ipv6GW",
    "InstanceChargeType" : "PostPaid",
    "RegionId" : "cn-huhehaote",
    "ResourceGroupId" : "rg-bp67acfmxazb4ph****",
    "Tags" : {
      "Key" : "FinanceDept",
      "Value" : "FinanceJoshua"
    }
  }
}

Error codes

For a list of error codes, see Service error codes.