查询对端网关
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名： vpc.api3.cloud.sunhongs.com。
本接口（DescribeCustomerGateways）用于查询对端网关列表。
默认接口请求频率限制：100次/秒。
接口更新时间：2019-03-28 11:27:35。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeCustomerGateways |
| Version | 是 | 否 | String | 公共参数，本接口取值：2017-03-12 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| CustomerGatewayIds | 否 | 否 | Array of String | 对端网关ID，例如：cgw-2wqq41m9。每次请求的实例的上限为100。参数不支持同时指定CustomerGatewayIds和Filters。 |
| Filters | 否 | 否 | Array of Filter | 过滤条件，详见下表：实例过滤条件表。每次请求的Filters的上限为10，Filter.Values的上限为5。参数不支持同时指定CustomerGatewayIds和Filters。<br><li>customer-gateway-id - String - （过滤条件）用户网关唯一ID形如：cgw-mgp33pll。</li><br><li>customer-gateway-name - String - （过滤条件）用户网关名称形如：test-cgw。</li><br><li>ip-address - String - （过滤条件）公网地址形如：58.211.1.12。</li> |
| Offset | 否 | 否 | Uint64 | 偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。 |
| Limit | 否 | 否 | Uint64 | 返回数量，默认为20，最大值为100。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CustomerGatewaySet | CustomerGateway | 此参数对外不可见。 对端网关对象列表 |
| TotalCount | Uint64 | 此参数对外不可见。 符合条件的实例数量。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.Malformed | |
| ResourceNotFound |