DescribeIpv6Gateways - IPv6 Gateway - Alibaba Cloud Documentation Center

Queries IPv6 gateways in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which the IPv6 gateway is deployed. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote
Ipv6GatewayId	string	No	The ID of the IPv6 gateway.	ipv6gw-hp3rwmtmfhgis****
VpcId	string	No	The ID of the virtual private cloud (VPC) to which the IPv6 gateway belongs.	vpc-123sedrfswd23****
Name	string	No	The name of the IPv6 gateway. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter. The name must start with a letter and cannot start with `http://` or `https://`.	ipv6GW
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
ResourceGroupId	string	No	The ID of the resource group to which the IPv6 gateway belongs.	rg-bp67acfmxazb4ph****
Tags	array<object>	No	The information about the tags.
	object	No
Key	string	No	The tag keys of the resources. You can specify up to 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	No	The tag values of the resources. You can specify up to 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length, and cannot contain `http://` or `https://`. The tag value cannot start with `aliyun` or `acs:`.	FinanceJoshua

Response parameters

Parameter	Type	Description	Example
	object	The returned message.
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	2
Ipv6Gateways	array<object>	The information about the IPv6 gateway.
	object
CreationTime	string	The time when the IPv6 gateway was created.	2020-12-20T14:51:23Z
Status	string	The status of the IPv6 gateway. Valid values: Pending Available	Available
VpcId	string	The ID of the VPC to which the IPv6 gateway belongs.	vpc-123sedrfswd23****
Description	string	The description of the IPv6 gateway.	descriptionforIPv6GW
Ipv6GatewayId	string	The ID of the IPv6 gateway.	ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****
ExpiredTime	string	The time when the IPv6 gateway expires.	2021-12-20T14:51:23Z
BusinessStatus	string	The status of the IPv6 gateway. Valid values: Normal FinancialLocked SecurityLocked	Normal
Name	string	The name of the IPv6 gateway.	ipv6GW
InstanceChargeType	string	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.	PostPaid
RegionId	string	The ID of the region in which the IPv6 gateway is deployed.	cn-huhehaote
ResourceGroupId	string	The resource group ID.	rg-bp67acfmxazb4ph****
Tags	array<object>	The information about the tags.
	object
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
  "PageNumber": 1,
  "TotalCount": 2,
  "Ipv6Gateways": {
    "Ipv6Gateway": [
      {
        "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": {
          "Tag": [
            {
              "Key": "FinanceDept",
              "Value": "FinanceJoshua"
            }
          ]
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history