帮你快速理解、总结文档立即下载

查询云应用服务版本信息

最近更新时间:2026-09-29 02:57:03
我的收藏

1. 接口描述

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

查询云应用服务版本信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeCloudAppVersion。
Version 是 String 公共参数,本接口取值:2018-06-08。
Region 否 String 公共参数,本接口不需要传递此参数。
EnvId 是 String

环境ID


示例值:lowcode-****
ServiceName 是 String

服务名


示例值:html
DeployType 是 String

部署类型


示例值:static-hosting
VersionName 否 String

版本名


示例值:html-002
BuildId 否 String

构建id


示例值:1212376236544

3. 输出参数

参数名称 类型 描述
BuildType String

构建类型


示例值:ZIP
BuildId String

构建Id


示例值:2*
Status String

构建状态


示例值:FAILED
Framework String

框架


示例值:other
StaticConfig StaticConfig

静态托管配置信息

BuildTime String

构建时间


示例值:2026-07-29 15:13:36
Steps Array of BuildStepStatus

[]BuildStepStatus 的 JSON 序列化

Snapshot String

服务版本快照


示例值:{"Source":[]}
TrafficPercent Integer

服务版本流量比例


示例值:0
VersionDomain String

服务版本域名


示例值:cluap-***
Resources Array of CloudAppResourceItem

服务管理资源列表

Artifacts Array of BuildArtifactInfo

[]ArtifactInfo 的 JSON 序列化

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询云应用信息

输入示例

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

{
    "EnvId": "lowcode-****************",
    "ServiceName": "html",
    "DeployType": "static-hosting",
    "VersionName": "html-002"
}

输出示例

{
    "Response": {
        "BuildId": "2*********",
        "BuildTime": "2026-07-29 15:13:36",
        "BuildType": "ZIP",
        "Framework": "other",
        "StaticConfig": {
            "AppPath": "/html",
            "BuildPath": "",
            "CodeBranch": "",
            "CodeRepo": "",
            "CodeSource": "",
            "CosSuffix": "zip",
            "CosTimestamp": "1*********",
            "Framework": "other",
            "NodeJsVersion": "18",
            "StaticCmd": {
                "BuildCmd": "",
                "DeployCmd": "tcb hosting deploy ./ /html",
                "InstallCmd": ""
            },
            "StaticEnv": {
                "Variables": null
            },
            "ZipFileUrl": ""
        },
        "Status": "FAILED",
        "Steps": null,
        "RequestId": "b47866f0-2863-4721-818a-34a6ecd37cf7",
        "VersionDomain": "cl*u*ap*-****************************************************************",
        "Snapshot": "{\"Source\":{\"Type\":\"zip\",\"Repo\":\"\",\"Ref\":\"\",\"Commit\":\"\",\"PackageFileName\":\"\"},\"TriggerType\":\"manual\",\"Steps\":[{\"Name\":\"build-image\",\"Command\":\"D=/tmp/ctx-probe; curl -fsSL \\\"$ZIP_FILE_URL\\\" -o /tmp/c.zip \\u0026\\u0026 mkdir -p $D \\u0026\\u0026 unzip -o -q /tmp/c.zip -d $D \\u0026\\u0026 ls -la $D \\u0026\\u0026 tar -C $D -cf - . | docker build --platform linux/amd64 -t \\\"$CLOUDBASE_IMAGE_URL\\\" -\"},{\"Name\":\"push-image\",\"Command\":\"printf '%s' \\\"$CLOUDBASE_TCR_PASSWORD\\\" | docker login -u \\\"$CLOUDBASE_TCR_USERNAME\\\" --password-stdin \\\"$CLOUDBASE_TCR_REGISTRY\\\" \\u0026\\u0026 docker push \\\"$CLOUDBASE_IMAGE_URL\\\"\"}],\"ServiceList\":[],\"Env\":[]}"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。
ResourceNotFound 资源不存在。