文档

DescribeIpv6Gateways - 查询已创建的IPv6网关

更新时间:
一键部署

调用DescribeIpv6Gateways接口查询某个地域下已创建的IPv6网关。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeIpv6GatewaysRead
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/*
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}

请求参数

名称类型必填描述示例值
RegionIdstring

IPv6 网关所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-huhehaote
Ipv6GatewayIdstring

IPv6 网关的 ID。

ipv6gw-hp3rwmtmfhgis****
VpcIdstring

IPv6 网关关联的 VPC ID。

vpc-123sedrfswd23****
Namestring

IPv6 网关的名称。

长度为 2~128 个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

ipv6GW
PageNumberinteger

当前页码。

1
PageSizeinteger

每页包含的条目数。

10
ResourceGroupIdstring

IPv6 网关所属的资源组 ID。

rg-bp67acfmxazb4ph****
Tagsarray<object>

标签列表信息。

object

标签列表信息。

Keystring

资源的标签键。最多支持输入 20 个标签键。如需传入该值,则不能输入空字符串。

一个标签键最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceDept
Valuestring

资源的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

FinanceJoshua

返回参数

名称类型描述示例值
object

返回的信息。

PageSizeinteger

每页包含的条目数。

10
RequestIdstring

请求 ID。

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

当前页码。

1
TotalCountinteger

查询到的条目数量。

2
Ipv6Gatewaysarray<object>

IPv6 网关的详细信息。

object

IPv6 网关的详细信息。

CreationTimestring

IPv6 网关的创建时间。

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

IPv6 网关的运行状态。取值:

  • Pending:配置中。

  • Available:可用。

Available
VpcIdstring

IPv6 网关关联的 VPC ID。

vpc-123sedrfswd23****
Descriptionstring

IPv6 网关的描述信息。

descriptionforIPv6GW
Ipv6GatewayIdstring

IPv6 网关的 ID。

ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****
ExpiredTimestring

IPv6 网关的过期时间。

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

IPv6 网关的状态,取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

  • SecurityLocked:安全锁定。

Normal
Namestring

IPv6 网关的名称。

ipv6GW
InstanceChargeTypestring

IPv6 网关的计费方式。

仅取值:PostPaid,表示后付费。

PostPaid
RegionIdstring

IPv6 网关的地域 ID。

cn-huhehaote
ResourceGroupIdstring

资源组 ID。

rg-bp67acfmxazb4ph****
Tagsarray<object>

标签列表信息。

object

标签列表信息。

Keystring

标签键。

FinanceDept
Valuestring

标签值。

FinanceJoshua

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史