All Products
Search
Document Center

IPv6 Gateway:DescribeIpv6Gateways

Last Updated:Feb 27, 2024

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.

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:DescribeIpv6GatewaysRead
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/*
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
Ipv6GatewayIdstringNo

The ID of the IPv6 gateway.

ipv6gw-hp3rwmtmfhgis****
VpcIdstringNo

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

vpc-123sedrfswd23****
NamestringNo

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
PageNumberintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

10
ResourceGroupIdstringNo

The ID of the resource group to which the IPv6 gateway belongs.

rg-bp67acfmxazb4ph****
Tagsobject []No

The information about the tags.

KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object

The returned message.

PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of entries returned.

2
Ipv6Gatewaysobject []

The information about the IPv6 gateway.

CreationTimestring

The time when the IPv6 gateway was created.

2020-12-20T14:51:23Z
Statusstring

The status of the IPv6 gateway. Valid values:

  • Pending
  • Available
Available
VpcIdstring

The ID of the VPC to which the IPv6 gateway belongs.

vpc-123sedrfswd23****
Descriptionstring

The description of the IPv6 gateway.

descriptionforIPv6GW
Ipv6GatewayIdstring

The ID of the IPv6 gateway.

ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****
ExpiredTimestring

The time when the IPv6 gateway expires.

2021-12-20T14:51:23Z
BusinessStatusstring

The status of the IPv6 gateway. Valid values:

  • Normal
  • FinancialLocked
  • SecurityLocked
Normal
Namestring

The name of the IPv6 gateway.

ipv6GW
InstanceChargeTypestring

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
RegionIdstring

The ID of the region in which the IPv6 gateway is deployed.

cn-huhehaote
ResourceGroupIdstring

The resource group ID.

rg-bp67acfmxazb4ph****
Tagsobject []

The information about the tags.

Keystring

The tag key.

FinanceDept
Valuestring

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 timeSummary of changesOperation
No change history