调用DescribeCustomerGateways按指定条件查询用户网关。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeCustomerGateways

要执行的操作，取值：DescribeCustomerGateways。

Version String 必选示例值：2020-04-01

API版本信息。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

PageNumber Integer 可选示例值：1

分页查询的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

CustomerGatewayIds.N String 可选示例值：cgw-3tehy13n2l4c6c0v****

用户网关的ID。

参数 - N：表示用户网关ID的序号。

多个ID之间用&分隔。

CustomerGatewayName String 可选示例值：CGW-te001

用户网关的名称。

IpAddress String 可选示例值：8.XX.XX.8

用户网关的出口IP地址。

ProjectName String 可选示例值：Project_1

用户网关所属的项目。

传入该字段，表示查询指定项目下的用户网关。

不传入该字段，表示查询所有项目的用户网关。

Status String 可选示例值：Available

用户网关的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

TagFilters.N.Key String 可选示例值：key1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

TagFilters.N.Values.M String 可选示例值：value1

根据标签查询资源时指定的标签值。

第一个 N：表示标签键的序号，取值范围：1～10。

第二个 N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

如果不传该参数仅传入TagFilters.N.Key，表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N，多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

IpVersion String 可选示例值：ipv4

VPN网关的IP地址协议类型，取值如下：

ipv4 （默认值）

ipv6

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

RequestId String 示例值：202203211611080102121461940900****

请求ID。

PageSize Integer 示例值：20

当前分页的行数。

PageNumber Integer 示例值：1

当前页码。

TotalCount Integer 示例值：33

符合条件的用户网关的总数。

CustomerGateways Object[] 示例值：-

用户网关的详细信息。

AccountId String 示例值：20005****

用户网关所属账户的ID。

CustomerGatewayId String 示例值：cgw-3tehy13n2l4c6c0v****

用户网关的ID。

IpAddress String 示例值：8.XX.XX.8

用户网关的出口IP地址。

ConnectionCount Integer 示例值：8

用户网关关联的IPsec连接的数量。

CreationTime String 示例值：2021-04-09T08:36:47+08:00

创建用户网关的时间。

UpdateTime String 示例值：2021-04-09T10:30:00+08:00

更新用户网关的时间。

CustomerGatewayName String 示例值：CGW-q04n

用户网关的名称。

Description String 示例值：This is a sample description

用户网关的描述信息。

Status String 示例值：Available

用户网关的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

ProjectName String 示例值：Project_1

用户网关所属的项目。

Asn Integer 示例值：65001

用户网关的ASN。

Tags Object[] 示例值：-

用户网关已添加的全部标签信息。

Key String 示例值：key1

标签键。

Value String 示例值：value1

标签值。

IpVersion String 示例值：ipv4

VPN网关的IP地址协议类型。

ipv4

ipv6

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.CustomerGatewayId	You've reached the limit on the number of customer gateway IDs that you can describe.	已达到可查询的用户网关ID数量上限。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。

VPN连接