文档中心

DescribeIpv6Gateways

最近更新时间：2023.11.07 08:12:35

首次发布时间：2022.10.10 09:46:29

调用 DescribeIpv6Gateways 接口，查询满足指定条件的IPv6网关。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的IPv6网关，若没有符合条件的IPv6网关，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有IPv6网关。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeIpv6Gateways	要执行的操作，取值为DescribeIpv6Gateways。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
Ipv6GatewayIds.N	List of String	否	Ipv6GatewayIds.1=ipv6gw-hp3rwmtmfhgis**&Ipv6GatewayIds.2=ipv6gw-hp3y0l3ln89j8**	IPv6网关实例的ID。参数 - N：表示IPv6网关实例ID的序号，取值范围为1 ～ 100，表示指定实例ID时最多可查询100个。多个IPv6网关实例ID间使用&分隔。
VpcIds.N	List of String	否	VpcIds.1=vpc-bp1opxu1zkhn00gzv**&VpcIds.2=vpc-bp67acfmxazb4p**	IPv6网关实例关联的VPC ID。您可以调用 DescribeVpcs 接口，查询VPC的ID。参数 - N：表示VPC实例ID的序号，取值范围为1 ～ 100，表示指定实例ID时最多可查询100个。多个VPC ID间使用&分隔。
Name	String	否	ipv6GW-01	IPv6网关实例的名称。
PageNumber	Integer	否	1	列表的页码。默认值为1。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	否	20	分页查询时每页的行数。最大值为100，默认值为20。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置。不填则从头开始查询。传入之前调用本API返回的`NextToken`，则从该次API调用标记分页的位置往后开始查询。
MaxResults	Integer	否	50	查询的数量，默认为 10，最大为100。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303301022514515207C4****	请求ID。
TotalCount	Integer	2	符合条件的IPv6网关总数。说明本参数即将下线，使用`NextToken`和`MaxResults`分页查询时，此参数无意义。
PageNumber	Integer	1	当前页码。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	10	当前分页的行数。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
Ipv6Gateways	Array of Struct	-	符合条件的IPv6网关实例的详细信息。具体请参见下表“ Ipv6Gateways结构 ”。

Ipv6Gateways结构

参数名称	类型	示例值	描述
CreationTime	String	2017-12-05T22:40:00+08:00	IPv6网关实例的创建时间。
UpdateTime	String	2017-12-05T22:40:00+08:00	IPv6网关实例的修改时间。
Status	String	Available	IPv6网关实例的运行状态。取值如下： Creating：创建中。 Deleteing：删除中 Available：可用。
VpcId	String	vpc-bp67acfmxazb4p****	IPv6网关实例关联的VPC ID。
Description	String	descriptionforIPv6GW	IPv6网关实例的描述信息。
Ipv6GatewayId	String	ipv6gw-hp3rwmtmfhgis****	IPv6网关实例的ID。
Name	String	ipv6GW-01	IPv6网关实例的名称。

请求示例

GET /?Action=DescribeIpv6Gateways&Version=2020-04-01&Ipv6GatewayIds.1=ipv6gw-hp3rwmtmfhgis****&Ipv6GatewayIds.2=ipv6gw-hp3y0l3ln89j8**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: vpc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "DescribeIpv6Gateways",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-guangzhou"
    }, 
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount":2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "Ipv6Gateways": [
            {
                "CreationTime": "2017-12-05T22:40:00+08:00",
                "UpdateTime": "2017-12-05T22:40:00+08:00",
                "Status": "Available",
                "VpcId": "vpc-bp67acfmxazb4p****",
                "Description": "descriptionforIPv6GW",
                "Ipv6GatewayId": "ipv6gw-hp3rwmtmfhgis****",
                "Name": "ipv6GW-01"
            },
            {
                "CreationTime": "2017-12-05T22:40:00+08:00",
                "UpdateTime": "2017-12-05T22:40:00+08:00",
                "Status": "Available",
                "VpcId": "vpc-bp1opxu1zkhn00gzv****",
                "Description": "descriptionforIPv6GW",
                "Ipv6GatewayId": "ipv6gw-hp3y0l3ln89j8****",
                "Name": "ipv6GW-02"
            }
        ]
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	InvalidMaxResults.Malformed	The specified parameter MaxResults is malformed.	查询数量不合法。
400	InvalidNextToken.Malformed	The specified parameter NextToken is invalid.	查询 NextToken 不合法。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidRouteNextHop.Malformed	The specified next hop is malformed.	指定的下一跳不合法。
400	LimitExceeded.Ipv6GatewayId	You've reached the limit on the number of Ipv6Gateway IDs that you can describe.	已达到可查询的IPv6网关的ID数量上限。
400	LimitExceeded.VpcId	You've reached the limit on the number of VPC IDs that you can describe.	已达到可查询的VPC ID数量上限。
404	InvalidRouteNextHop.NotFound	The specified next hop does not exist.	指定的下一跳不存在。

调用说明

请求参数

返回数据

请求示例

返回示例

错误码