1. 接口描述
接口请求域名: lowcode.tencentcloudapi.com 。
发布应用
默认接口请求频率限制:20次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DeployApp。 | 
| Version | 是 | String | 公共参数,本接口取值:2021-01-08。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| EnvId | 是 | String | 环境ID 示例值:lowcode-5gzbnlvd93 | 
| Id | 是 | String | 应用id 示例值:app-k82WCPM8 | 
| Mode | 否 | String | 发布体验preview/正式upload 示例值:upload | 
| BuildType | 否 | String | 构建类型:mp、pc、web、adminPortal 示例值:web | 
| SubAppIds.N | 否 | Array of String | 子包数组 示例值:["sub-7x28cST"] | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| BuildId | String | 构建id 示例值:bcad608f-9293-4f12-b62b | 
| DeployErrCode | Integer | 发布错误code 示例值:0 | 
| DeployErrMsg | String | 发布错误信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:发布错误 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 发布应用
输入示例
POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeployApp
<公共请求参数>
{
    "BuildType": "web",
    "Id": "app-k82WCM8",
    "Mode": "upload",
    "EnvId": "lowcode-5gzbnlv393348d",
    "SubAppIds": [
        "sub-7x2cST"
    ]
}输出示例
{
    "Response": {
        "BuildId": "bcad608f-962b-c1c6f403d6e1",
        "DeployErrCode": 0,
        "DeployErrMsg": "",
        "RequestId": "1cfaee37-93e8c08c47d"
    }
}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 | 参数错误。 | 
| InvalidParameterValue | 参数取值错误。 |