1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
创建云开发网关API
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateCloudBaseGWAPI。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ServiceId | 是 | String | Service ID 示例值：env-123 |
| Path | 是 | String | API Path 示例值：/test |
| Type | 是 | Integer | API类型（1表示云函数，2表示容器） 示例值：2 |
| Name | 是 | String | API Name 示例值：servicename |
| APIId | 否 | String | APIId，如果非空，表示修改绑定Path 示例值：xxxxx-xxxxx-xxxxx-xxxxx-xxxxx |
| Custom | 否 | String | 自定义值通用字段（当Type为容器时必填） |
| AuthSwitch | 否 | Integer | 认证开关 1为开启 2为关闭 示例值：2 |
| EnableRegion | 否 | Boolean | 是否开启多地域 示例值：true |
| EnableUnion | 否 | Boolean | 是否启用统一域名 示例值：true |
| Domain | 否 | String | 域名 示例值：* |
| AccessTypes.N | 否 | Array of String | 访问类型："OA", "PUBLIC", "MINIAPP", "VPC" （不传默认PUBLIC+MINIAPP+VPC） 示例值：["OA", "PUBLIC", "MINIAPP", "VPC"] |
| IsShortPath | 否 | Boolean | 是否开启路径透传，默认true表示短路径，即不开启路径透传(已弃用) 示例值：true |
| PathTransmission | 否 | Integer | 路径透传，默认0关闭，1开启，2关闭 示例值：2 |
| EnableCheckAcrossDomain | 否 | Integer | 跨域校验，默认0开启，1开启，2关闭 示例值：1 |
| StaticFileDirectory | 否 | String | 静态托管资源目录 示例值：/TEST |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| APIId | String | API ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxxxx-xxxxx-xxxxx-xxxxx-xxxxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例一
输入示例
https://tcb.tencentcloudapi.com/?Action=CreateCloudBaseGWAPI
&Path="/second"
&Type=1
&Name="function-2"
&ServiceId="roy-test-666"
&AuthSwitch=0
&<公共请求参数>输出示例
{
"Response": {
"APIId": "096d11d0-6f3f-4915-a872-4bcba43b7d31",
"RequestId": "a7998619-e189-484b-b439-922104d2321f"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.SystemFail | 系统失败。 |
| InvalidParameter.APICreated | API已经创建。 |
| InvalidParameter.APINotExist | API不存在。 |
| InvalidParameter.APIThreshold | API超过阈值。 |
| InvalidParameter.APITypeNotSupport | API类型不支持。 |
| InvalidParameter.PathExist | 路径已存在。 |
| InvalidParameter.ServiceEvil | 没有操作权限。 |
| ResourceUnavailable.CDNFreezed | 资源不可用，CDN冻结。 |
