1. 接口描述
接口请求域名: vpc.api3.gsesgpucloud.com。
本接口(DescribeLocalGateway)用于查询CDC的本地网关。
默认接口请求频率限制:20次/秒。
接口更新时间:2024-10-21 14:35:00。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:DescribeLocalGateway |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
Filters | 否 | 是 | Array of Filter | 查询条件: vpc-id:按照VPCID过滤,local-gateway-name:按照本地网关名称过滤,名称支持模糊搜索,local-gateway-id:按照本地网关实例ID过滤,cdc-id:按照cdc实例ID过滤查询。 示例值:查看 |
Offset | 否 | 是 | Int64 | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。示例值: |
Limit | 否 | 是 | Int64 | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。示例值: |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
LocalGatewaySet | LocalGateway | 本地网关信息集合。 示例值:查看 |
TotalCount | Int64 | 本地网关总数。 示例值: |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数值不合法。 |
InvalidParameter | 入参不合法。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
ResourceNotFound | 资源不存在。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
InternalError |