All Products
Search
Document Center

IPv6 Gateway:DescribeIpv6GatewayAttribute

Last Updated:Mar 04, 2024

Queries the information about an IPv6 gateway, including the region, virtual private cloud (VPC), status, and billing method.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeIpv6GatewayAttributeRead
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
Ipv6GatewayIdstringYes

The ID of the IPv6 gateway that you want to query.

ipv6gw-hp3y0l3ln89j8cdvf****

Response parameters

ParameterTypeDescriptionExample
object
VpcIdstring

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

vpc-123sedrfswd23****
Statusstring

The status of the IPv6 gateway. Valid values:

  • Pending
  • Available
Available
CreationTimestring

The time when the IPv6 gateway was created.

2018-12-05T09:21:35Z
RegionIdstring

The ID of the region where the IPv6 gateway is deployed.

cn-huhehaote
InstanceChargeTypestring

The metering method of the IPv6 gateway.

PostPaid
RequestIdstring

The ID of the request.

0ED8D006-F706-4D23-88ED-E11ED28DCAC
Ipv6GatewayIdstring

The ID of the IPv6 gateway.

ipv6gw-hp3y0l3ln89j8cdvf****
Descriptionstring

The description of the IPv6 gateway.

test
ExpiredTimestring

The time when the IPv6 gateway expires.

2019-1-05T09:21:35Z
BusinessStatusstring

The service status of the IPv6 gateway. Valid values:

  • Normal: The IPv6 gateway runs as expected.
  • FinacialLocked: The IPv6 gateway is locked due to overdue payments.
  • SecurityLocked: The IPv6 gateway is locked due to security reasons.
Normal
Namestring

The name of the IPv6 gateway.

test
ResourceGroupIdstring

The ID of the resource group.

rg-acfmxazb4ph6aiy****
GatewayRouteTableIdstring

The ID of the gateway route table associated with the IPv6 gateway.

Note This parameter is available only when the IPv6 gateway is associated with a gateway route table.
vtb-5ts0ohchwkp3dydt2****
Tagsobject []

The list of tags.

Keystring

The tag key.

FinanceDept
Valuestring

The tag value.

FinanceJoshua

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history