DescribeIpv6GatewayAttribute

Queries the details of a specified IPv6 gateway, including the region, VPC, running status, and billing method.

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:DescribeIpv6GatewayAttribute

get

*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	Yes	The ID of the IPv6 gateway to query.	ipv6gw-hp3y0l3ln89j8cdvf****
RegionId	string	Yes	The ID of the region where the IPv6 gateway is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
VpcId	string	The ID of the VPC to which the IPv6 gateway belongs.	vpc-123sedrfswd23****
Status	string	The status of the IPv6 gateway. Valid values: Pending: being configured. Available: active.	Available
CreationTime	string	The time when the IPv6 gateway was created.	2018-12-05T09:21:35Z
RegionId	string	The region ID of the IPv6 gateway.	cn-huhehaote
InstanceChargeType	string	The billing method of the IPv6 gateway.	PostPaid
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC
Ipv6GatewayId	string	The instance ID of the IPv6 gateway.	ipv6gw-hp3y0l3ln89j8cdvf****
Description	string	The description of the IPv6 gateway.	test
ExpiredTime	string	The expiration time of the IPv6 gateway.	2019-1-05T09:21:35Z
BusinessStatus	string	The business status of the IPv6 gateway. Valid values: Normal: Normal. FinancialLocked: financial lock. SecurityLocked: security lock.	Normal
Name	string	The name of the IPv6 gateway.	test
ResourceGroupId	string	The resource group ID.	rg-acfmxazb4ph6aiy****
GatewayRouteTableId	string	The ID of the gateway route table associated with the IPv6 gateway. Note This parameter is displayed only for IPv6 gateways that are associated with a gateway route table.	vtb-5ts0ohchwkp3dydt2****
Tags	object
Tag	array<object>	The tag list.
	object	The tag list.
Key	string	The key of tag N. You can specify at most 20 tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceDept
Value	string	The value of tag N. You can specify at most 20 tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It must start with a letter and can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	FinanceJoshua
OwnerId	integer	The Alibaba Cloud account ID of the IPv6 gateway owner. Important This value is of the Long type. Precision loss may occur in certain programming languages. Use this value with caution.	2546073170691****

Examples

Success response

JSON format

{
  "VpcId": "vpc-123sedrfswd23****",
  "Status": "Available",
  "CreationTime": "2018-12-05T09:21:35Z",
  "RegionId": "cn-huhehaote",
  "InstanceChargeType": "PostPaid",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC",
  "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8cdvf****",
  "Description": "test",
  "ExpiredTime": "2019-1-05T09:21:35Z",
  "BusinessStatus": "Normal",
  "Name": "test",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "GatewayRouteTableId": "vtb-5ts0ohchwkp3dydt2****",
  "Tags": {
    "Tag": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "OwnerId": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.