云开发 CloudBase 查询一键部署任务-云托管相关接口-API 中心-腾讯云

1. 接口描述

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

查询一键部署任务（特定接口：外部查询使用）

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudBaseRunOneClickTaskExternal。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	否	String	公共参数，本接口不需要传递此参数。
ExternalId	是	String	外部任务Id 最长64字节示例值：1423443

3. 输出参数

参数名称	类型	描述
ExternalId	String	外部任务Id 示例值：sdkfldf
EnvId	String	弃用示例值：env-sdfsdf
UserUin	String	用户uin 示例值：10010123123
ServerName	String	服务名示例值：server
VersionName	String	版本名示例值：version
CreateTime	String	创建时间示例值：2024-12-01 12:00:00
Stage	String	当前阶段微信云托管环境创建阶段：envStage 存储资源创建阶段：storageStage 服务创建阶段：serverStage 示例值：envStage
Status	String	状态 running stopped failed finished 示例值：running
FailReason	String	失败原因示例值：reason
UserEnvId	String	用户envId 示例值：env-sdfsdf
StartTime	String	创建时间示例值：2024-12-01 12:00:00
Steps	Array of OneClickTaskStepInfo	步骤信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeCloudBaseRunOneClickTaskExternal

输入示例

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

{
    "ExternalId": "sdfsdlkjfdsl"
}

输出示例

{
    "Response": {
        "Status": "running",
        "UserEnvId": "env-sdsfd",
        "EnvId": "env-sdfsdf",
        "ServerName": "server",
        "FailReason": "",
        "ExternalId": "",
        "RequestId": "sdfsdfsdf",
        "VersionName": "",
        "UserUin": "13432424",
        "CreateTime": "2024-12-01 12:00:00",
        "StartTime": "2024-12-01 12:00:00",
        "Stage": "envStage",
        "Steps": []
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameter	参数错误。
LimitExceeded	超过配额限制。
ResourceInUse	资源被占用。
ResourceNotFound	资源不存在。

查询一键部署任务

本页目录：