Queries the detailed information about an IPv6 gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-huhehaote

The ID of the region where the IPv6 gateway is deployed. You can call the DescribeRegions operation to query the most recent region list.

Ipv6GatewayId String Yes ipv6gw-hp3y0l3ln89j8cdvf****

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

Action String Yes DescribeIpv6GatewayAttribute

The operation that you want to perform. Set the value to DescribeIpv6GatewayAttribute.

Response parameters

Parameter Type Example Description
VpcId String vpc-123sedrfswd23****

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

Status String Available

The status of the IPv6 gateway. Valid values:

  • Pending
  • Available
CreationTime String 2018-12-05T09:21:35Z

The time when the IPv6 gateway was created.

RegionId String cn-huhehaote

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

InstanceChargeType String PostPaid

The metering method of the IPv6 gateway.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC

The ID of the request.

Ipv6GatewayId String ipv6gw-hp3y0l3ln89j8cdvf****

The ID of the IPv6 gateway.

Description String test

The description of the IPv6 gateway.

ExpiredTime String 2019-1-05T09:21:35Z

The time when the IPv6 gateway expires.

BusinessStatus String Normal

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.
Name String test

The name of the IPv6 gateway.

ResourceGroupId String rg-acfmxazb4ph6aiy****

The ID of the resource group.

Tags Array of Tag

The list of tags.

Tag
Key String FinanceDept

The tag key.

Value String FinanceJoshua

The tag value.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-huhehaote
&Ipv6GatewayId=ipv6gw-hp3y0l3ln89j8cdvf****
&Action=DescribeIpv6GatewayAttribute
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeIpv6GatewayAttributeResponse>
    <VpcId>vpc-123sedrfswd23****</VpcId>
    <Status>Available</Status>
    <CreationTime>2018-12-05T09:21:35Z</CreationTime>
    <RegionId>cn-huhehaote</RegionId>
    <InstanceChargeType>PostPaid</InstanceChargeType>
    <RequestId>0ED8D006-F706-4D23-88ED-E11ED28DCAC</RequestId>
    <Ipv6GatewayId>ipv6gw-hp3y0l3ln89j8cdvf****</Ipv6GatewayId>
    <Description>test</Description>
    <ExpiredTime>2019-1-05T09:21:35Z</ExpiredTime>
    <BusinessStatus>Normal</BusinessStatus>
    <Name>test</Name>
    <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
    <Tags>
        <Key>FinanceDept</Key>
        <Value>FinanceJoshua</Value>
    </Tags>
</DescribeIpv6GatewayAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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****",
  "Tags" : {
    "Key" : "FinanceDept",
    "Value" : "FinanceJoshua"
  }
}

Error codes

HTTP status code Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.

For a list of error codes, see Service error codes.