DescribeIpv6Gateways-阿里云帮助中心

Queries the IPv6 gateways in a specified region.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeIpv6Gateways

get

Ipv6Gateway

acs:vpc:{#regionId}:{#accountId}:ipv6gateway/*

Ipv6Gateway

acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv6 gateway. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
Ipv6GatewayId	string	No	The ID of the IPv6 gateway.	ipv6gw-hp3rwmtmfhgis****
VpcId	string	No	The ID of the VPC associated with the IPv6 gateway.	vpc-123sedrfswd23****
Name	string	No	The name of the IPv6 gateway. The name must be 2 to 128 characters in length, and must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It 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 list of tags.
	object	No	The list of tags.
Key	string	No	The tag key of the resource. You can specify up to 20 tag keys. If you specify this parameter, you cannot specify an empty string. A 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 value of the resource. You can specify up to 20 tag values. If you specify this parameter, you can specify an empty string. A tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua

Response elements

Element	Type	Description	Example
	object	The response information.
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	object
Ipv6Gateway	array<object>	The details of the IPv6 gateways.
	array<object>	The details of the IPv6 gateways.
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: The IPv6 gateway is being configured. Available: The IPv6 gateway is available.	Available
VpcId	string	The ID of the VPC associated with the IPv6 gateway.	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 expiration time of the IPv6 gateway.	2021-12-20T14:51:23Z
BusinessStatus	string	The business status of the IPv6 gateway. Valid values: Normal: Normal. FinancialLocked: Locked due to overdue payment. SecurityLocked: Locked due to security reasons.	Normal
Name	string	The name of the IPv6 gateway.	ipv6GW
InstanceChargeType	string	The billing method of the IPv6 gateway. Valid value: PostPaid, which indicates the pay-as-you-go billing method.	PostPaid
RegionId	string	The region ID of the IPv6 gateway.	cn-huhehaote
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4ph****
Tags	object
Tag	array<object>	The list of tags.
	object	The list of tags.
Key	string	The tag key.	FinanceDept
Value	string	The tag value.	FinanceJoshua
OwnerId	integer	The Alibaba Cloud account ID to which the IPv6 gateway belongs. Important This value is of the Long type. Precision loss may occur in some programming languages. Use this value with caution.	2546073170691****

Examples

Success response

JSON format

{
  "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"
            }
          ]
        },
        "OwnerId": 0
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.