调用DescribeIpv6Gateways接口查询已创建的IPv6网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 是 | cn-huhehaote | IPv6网关所属的地域ID。 说明 目前,支持开通IPv6网段的地域:华北1(青岛)、华北2(北京)、华北3(张家口)、华北5(呼和浩特)、华北6(乌兰察布)、华东1(杭州)、华东2(上海)、华南1(深圳)、华南2(河源)、华南3(广州)、西南1(成都)、中国香港、菲律宾(马尼拉)、新加坡、美国(弗吉尼亚)、德国(法兰克福)。 |
Ipv6GatewayId | String | 否 | ipv6gw-hp3rwmtmfhgis**** | IPv6网关的ID。 |
VpcId | String | 否 | vpc-123sedrfswd23**** | IPv6网关关联的VPC ID。 |
Name | String | 否 | ipv6GW | IPv6网关的名称。 长度为2~256个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以 |
PageNumber | Integer | 否 | 1 | 当前页码。 |
PageSize | Integer | 否 | 10 | 每页包含的条目数。 |
Action | String | 是 | DescribeIpv6Gateways | 系统规定参数。取值:DescribeIpv6Gateways。 |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4ph**** | 资源组ID。 |
Tags.N.Key | String | 否 | FinanceDept | 标签键。一旦输入该值,则不允许为空字符串。 最多支持64个字符,不能以 一次最多支持输入20个标签键。 |
Tags.N.Value | String | 否 | FinanceJoshua | 标签值。 标签值最多支持128个字符,可以为空字符串,不能以 一个标签键对应一个标签值。一次最多支持输入20个标签值。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageSize | Integer | 10 | 每页包含的条目数。 |
RequestId | String | E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD | 请求ID。 |
PageNumber | Integer | 1 | 当前页码。 |
TotalCount | Integer | 2 | 查询到的条目数量。 |
Ipv6Gateways | Array of Ipv6Gateway | IPv6网关的详细信息。 |
|
Ipv6Gateway | |||
CreationTime | String | 2020-12-20T14:51:23Z | IPv6网关的创建时间。 |
Status | String | Available | IPv6网关的运行状态。取值:
|
VpcId | String | vpc-123sedrfswd23**** | IPv6网关关联的VPC ID。 |
Description | String | descriptionforIPv6GW | IPv6网关的描述信息。 |
Ipv6GatewayId | String | ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis**** | IPv6网关的ID。 |
ExpiredTime | String | 2021-12-20T14:51:23Z | IPv6网关的过期时间。 |
BusinessStatus | String | Normal | IPv6网关的状态,取值:
|
Name | String | ipv6GW | IPv6网关的名称。 |
InstanceChargeType | String | PostPaid | IPv6网关的计费方式。 仅取值:PostPaid,表示后付费。 |
RegionId | String | cn-huhehaote | IPv6网关的地域ID。 |
ResourceGroupId | String | rg-bp67acfmxazb4ph**** | 资源组ID。 |
Tags | Array of Tag | 标签列表信息。 |
|
Tag | |||
Key | String | FinanceDept | 标签键。 |
Value | String | FinanceJoshua | 标签值。 |
示例
请求示例
http(s)://[Endpoint]/?RegionId=cn-huhehaote
&Ipv6GatewayId=ipv6gw-hp3rwmtmfhgis****
&VpcId=vpc-123sedrfswd23****
&Name=ipv6GW
&PageNumber=1
&PageSize=10
&Action=DescribeIpv6Gateways
&ResourceGroupId=rg-bp67acfmxazb4ph****
&Tags=[{"Key":"FinanceDept","Value":"FinanceJoshua"}]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeIpv6GatewaysResponse>
<PageSize>10</PageSize>
<RequestId>E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD</RequestId>
<PageNumber>1</PageNumber>
<TotalCount>2</TotalCount>
<Ipv6Gateways>
<CreationTime>2020-12-20T14:51:23Z</CreationTime>
<Status>Available</Status>
<VpcId>vpc-123sedrfswd23****</VpcId>
<Description>descriptionforIPv6GW</Description>
<Ipv6GatewayId>ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****</Ipv6GatewayId>
<ExpiredTime>2021-12-20T14:51:23Z</ExpiredTime>
<BusinessStatus>Normal</BusinessStatus>
<Name>ipv6GW</Name>
<InstanceChargeType>PostPaid</InstanceChargeType>
<RegionId>cn-huhehaote</RegionId>
<ResourceGroupId>rg-bp67acfmxazb4ph****</ResourceGroupId>
<Tags>
<Key>FinanceDept</Key>
<Value>FinanceJoshua</Value>
</Tags>
</Ipv6Gateways>
</DescribeIpv6GatewaysResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"PageSize" : 10,
"RequestId" : "E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD",
"PageNumber" : 1,
"TotalCount" : 2,
"Ipv6Gateways" : {
"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" : {
"Key" : "FinanceDept",
"Value" : "FinanceJoshua"
}
}
}
错误码
访问错误中心查看更多错误码。