DescribeAPIDocs
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
查询 API 文档列表
默认接口请求频率限制：20次/秒。
接口更新时间：2021-04-25 15:06:57。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAPIDocs |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Int64 | 返回数量，默认为 20，最大值为 100。 |
| Offset | 否 | 否 | Int64 | 偏移量，默认为 0。 |
| Filters | 否 | 否 | Array of Filter | 此参数对外不可见。 过滤条件。预留字段，目前不支持过滤。 |
| Order | 否 | 否 | String | 此参数对外不可见。 排序依据，默认按照插件创建时间排序。 |
| OrderBy | 否 | 否 | String | 此参数对外不可见。 排序方式，默认倒序排序。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | APIDocs | API文档列表信息 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| InternalError | 内部错误。 |
| ResourceInUse | 资源被占用。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| LimitExceeded | 超过配额限制。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |
| UnsupportedOperation.InvalidAction | 接口错误。 |