获取投递规则
最近更新时间: 2024-06-18 14:31:27
1. 接口描述
接口请求域名： cls.api3.fincloud.tencent.cn。
获取投递规则信息列表
默认接口请求频率限制：20次/秒。
接口更新时间：2022-10-31 11:10:35。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeShippers |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-10-16 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| Filters | 否 | 否 | Array of Filter | <br><li> shipperName<br><br>按照【投递规则名称】进行过滤。<br>类型：String<br><br>必选：否<br><br><br><li> shipperId<br><br>按照【投递规则ID】进行过滤。<br>类型：String<br><br>必选：否<br><br><br><li> topicId<br><br>按照【日志主题】进行过滤。<br><br>类型：String<br><br>必选：否<br><br>每次请求的Filters的上限为10，Filter.Values的上限为5。 |
| Offset | 否 | 否 | Uint64 | 分页的偏移量，默认值为0 |
| Limit | 否 | 否 | Uint64 | 分页单页的限制数目，默认值为20，最大值100 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Shippers | ShipperInfo | 此参数对外不可见。 投递规则列表 |
| TotalCount | Uint64 | 此参数对外不可见。 本次查询获取到的总数 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| InternalError | |
| LimitExceeded | |
| FailedOperation | |
| AuthFailure | |
| OperationDenied | |
| OperationDenied.ACLFailed | |
| OperationDenied.AccountIsolate | |
| OperationDenied.AccountDestroy | |
| OperationDenied.AccountNotExists |