CreateAPIDoc
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
创建 API 文档
默认接口请求频率限制:20次/秒。
接口更新时间:2021-04-25 15:07:11。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:CreateAPIDoc |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| ApiDocName | 是 | 否 | String | API文档名称 |
| ServiceId | 是 | 否 | String | 服务名称 |
| Environment | 是 | 否 | String | 环境名称 |
| ApiIds | 是 | 否 | Array of String | 生成文档的API列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | APIDoc | API文档基本信息 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.InvalidService | 对应服务不可见。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| UnauthorizedOperation | 未授权操作。 |
| ResourceNotFound.InvalidApi | ApiId错误。 |
| FailedOperation.ApiBindEnvironmen | 该api绑定了使用计划。 |
| MissingParameter | 缺少参数错误。 |
| InternalError | 内部错误。 |
| FailedOperation.ServiceError | 服务相关的错误。 |
| FailedOperation.ApiError | api类错误。 |
| ResourceNotFound.InvalidAccessKeyId | 密钥不存在。 |
| ResourceInUse | 资源被占用。 |
| InvalidParameter | 参数错误。 |
| AuthFailure | CAM签名/鉴权错误。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInsufficient | 资源不足。 |
| LimitExceeded | 超过配额限制。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccessKeyExist | 自定义密钥已存在。 |
| FailedOperation.ApiBindEnvironment | Apis 绑定了使用计划,请先解绑再试。 |
| InvalidParameterValue.LimitExceeded | 参数个数超出限制,上限为100。 |
| FailedOperation.CodingError | API文档操作失败。 |
| LimitExceeded.APIDocLimitExceeded | API文档数量超出限制。 |