1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
创建云应用
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateCloudApp。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:lowcode-*f985f96 |
| ServiceName | 是 | String | 服务名 示例值:html |
| DeployType | 是 | String | 部署类型 示例值:static-hosting |
| BuildType | 否 | String | 构建类型 示例值:ZIP |
| StaticConfig | 否 | StaticConfig | 静态应用创建配置信息 |
| Source | 否 | BuildSource | 源码定义 |
| Commands | 否 | BuildCommands | Commands 与 CustomSteps 至少填一个 |
| Env.N | 否 | Array of Variable | Commands 与 CustomSteps 至少填一个,docker 镜像构建场景强烈建议用 CustomSteps |
| CustomSteps.N | 否 | Array of BuildStep | 非敏感环境变量,构建容器中以 $KEY 引用 |
| Secrets.N | 否 | Array of BuildSecret | 敏感凭证(AES 加密落库),构建容器中以 $SECRET_NAME 引用 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BuildId | String | 构建Id 示例值:26014*82 |
| VersionName | String | 版本名称 示例值:html-002 |
| ServiceName | String | 服务名称 示例值:html |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建云应用
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCloudApp
<公共请求参数>
{
"EnvId": "lowcode-*********f985f96",
"ServiceName": "html",
"DeployType": "static-hosting",
"BuildType": "ZIP",
"StaticConfig": {
"Framework": "other",
"NodeJsVersion": "18",
"AppPath": "/html",
"CosTimestamp": "17****9**5",
"CosSuffix": "zip",
"StaticCmd": {
"DeployCmd": "tcb hosting deploy ./ /html"
}
}
}
输出示例
{
"Response": {
"BuildId": "26014**8*2",
"ServiceName": "html",
"VersionName": "html-002",
"RequestId": "ba0e079a-c85d-43ec-a313-7e88f251646c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。 |
| LimitExceeded.ErrNamespaceMaxLimit | 命名空间超过配额。 |
| LimitExceeded.ErrRepoMaxLimit | 镜像容器超过配额。 |
| ResourceNotFound | 资源不存在。 |