API 网关创建 API 文档-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： apigateway.tencentcloudapi.com 。

创建 API 文档

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateAPIDoc。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
ApiDocName	是	String	API文档名称示例值：ApiGateWay Doc
ServiceId	是	String	服务名称示例值：service-2nuhovb7
Environment	是	String	环境名称示例值：release
ApiIds.N	是	Array of String	生成文档的API列表示例值：[api-2dvasde2,api-zewq23]
Tags.N	否	Array of Tag	标签

3. 输出参数

参数名称	类型	描述
Result	APIDoc	API文档基本信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 CreateAPIDoc

输入示例

POST / HTTP/1.1
Host: apigateway.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAPIDoc
<公共请求参数>

{
    "ApiDocName": "test",
    "ServiceId": "service-2nuhovb7",
    "Environment": "release",
    "ApiIds": [
        "api-2dvasde2",
        "api-zewq23"
    ]
}

输出示例

{
    "Response": {
        "Result": {
            "ApiDocId": "apidoc-a7ragqam",
            "ApiDocName": "test",
            "ApiDocStatus": "PROCESSING"
        },
        "RequestId": "ef2f184f-8044-43f1-b807-6761f259c35f"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation	操作失败。
FailedOperation.AccessKeyExist	自定义密钥已存在。
FailedOperation.ApiBindEnvironmen	该api绑定了使用计划。
FailedOperation.ApiBindEnvironment	Apis 绑定了使用计划，请先解绑再试。
FailedOperation.ApiError	api类错误。
FailedOperation.CodingError	API文档操作失败。
FailedOperation.ServiceError	服务相关的错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.FormatError	参数格式错误。
InvalidParameterValue.LimitExceeded	参数个数超出限制，上限为100。
LimitExceeded	超过配额限制。
LimitExceeded.APIDocLimitExceeded	API文档数量超出限制。
MissingParameter	缺少参数错误。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceInUse	资源被占用。
ResourceInsufficient	资源不足。
ResourceNotFound	资源不存在。
ResourceNotFound.InvalidAccessKeyId	密钥不存在。
ResourceNotFound.InvalidApi	ApiId错误。
ResourceNotFound.InvalidService	对应服务不可见。
UnauthorizedOperation	未授权操作。