BuildAPIDoc
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
构建 API 文档
默认接口请求频率限制：20次/秒。
接口更新时间：2021-04-21 10:42:11。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：BuildAPIDoc |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ApiDocId | 是 | 否 | String | API文档ID |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | Bool | 操作是否成功 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound.InvalidService | 对应服务不可见。 |
| ResourceNotFound.InvalidApi | ApiId错误。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.ApiError | api类错误。 |
| FailedOperation.CodingError | API文档操作失败。 |
| ResourceNotFound.InvalidApiDoc | API文档不存在。 |