1. 接口描述
接口请求域名: bhsaas.api3.fincloud.tencent.com。
查询命令模板列表
默认接口请求频率限制:20次/秒。
接口更新时间:2023-09-05 03:35:25。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeCmdTemplates |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-10-18 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| IdSet | 否 | 否 | Array of Uint64 | 命令模板ID集合,非必需 示例值: [1,2] |
| Name | 否 | 否 | String | 命令模板名,模糊查询,最大长度64字符 示例值: CmdTempName |
| Type | 否 | 是 | Uint64 | 命令模板类型 1-内置模板 2-自定义模板 示例值: 1 |
| Offset | 否 | 否 | Uint64 | 分页偏移位置,默认值为0 示例值: 0 |
| Limit | 否 | 否 | Uint64 | 每页条目数量,默认20 示例值: 10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CmdTemplateSet | Array of CmdTemplate | 命令模板列表 示例值:查看 |
| TotalCount | Uint64 | 总记录数 示例值: 10 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameterValue | 参数取值错误。 |