DescribeIpv6Gateways - 查询已创建的IPv6网关 - 专有网络 VPC

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeIpv6Gateways	get	Ipv6Gateway `acs:vpc:{#regionId}:{#accountId}:ipv6gateway/` *Ipv6Gateway `acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	IPv6 网关所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-huhehaote
Ipv6GatewayId	string	否	IPv6 网关的 ID。	ipv6gw-hp3rwmtmfhgis****
VpcId	string	否	IPv6 网关关联的 VPC ID。	vpc-123sedrfswd23****
Name	string	否	IPv6 网关的名称。长度为 2~128 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-）。但不能以`http://`或`https://`开头。	ipv6GW
PageNumber	integer	否	当前页码。	1
PageSize	integer	否	每页包含的条目数。	10
ResourceGroupId	string	否	IPv6 网关所属的资源组 ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	否	标签列表信息。
	object	否	标签列表信息。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua

返回参数

名称	类型	描述	示例值
	object	返回的信息。
PageSize	integer	每页包含的条目数。	10
RequestId	string	请求 ID。	E3A06196-3E7C-490D-8F39-CB4B5A0CE8AD
PageNumber	integer	当前页码。	1
TotalCount	integer	查询到的条目数量。	2
Ipv6Gateways	array<object>	IPv6 网关的详细信息。
Ipv6Gateway	object	IPv6 网关的详细信息。
CreationTime	string	IPv6 网关的创建时间。	2020-12-20T14:51:23Z
Status	string	IPv6 网关的运行状态。取值： Pending：配置中。 Available：可用。	Available
VpcId	string	IPv6 网关关联的 VPC ID。	vpc-123sedrfswd23****
Description	string	IPv6 网关的描述信息。	descriptionforIPv6GW
Ipv6GatewayId	string	IPv6 网关的 ID。	ipv6gw-hp3rwmtmfhgisipv6gw-hp3rwmtmfhgis****
ExpiredTime	string	IPv6 网关的过期时间。	2021-12-20T14:51:23Z
BusinessStatus	string	IPv6 网关的状态，取值： Normal：正常。 FinancialLocked：欠费锁定。 SecurityLocked：安全锁定。	Normal
Name	string	IPv6 网关的名称。	ipv6GW
InstanceChargeType	string	IPv6 网关的计费方式。仅取值：PostPaid，表示后付费。	PostPaid
RegionId	string	IPv6 网关的地域 ID。	cn-huhehaote
ResourceGroupId	string	资源组 ID。	rg-bp67acfmxazb4ph****
Tags	array<object>	标签列表信息。
Tag	object	标签列表信息。
Key	string	标签键。	FinanceDept
Value	string	标签值。	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"
            }
          ]
        }
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	Forbidden	User not authorized to operate on the specified resource.	您没有权限操作指定资源，请申请权限后再操作。

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

变更历史

变更时间	变更内容概要	操作
2024-07-31	OpenAPI 错误码发生变更	查看变更详情