云托管 CloudBase Run 查询服务管理任务信息

1. 接口描述

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

查询服务管理任务信息

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeServerManageTask。
Version	是	String	公共参数，本接口取值：2022-02-17。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境Id 示例值：test-1gbtbgkjf8f48e2c
ServerName	是	String	服务名示例值：server
TaskId	是	Integer	任务Id 示例值：1000
OperatorRemark	否	String	操作标识示例值：remark

3. 输出参数

参数名称	类型	描述
IsExist	Boolean	是否存在示例值：true
Task	ServerManageTaskInfo	任务信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询服务管理任务信息

输入示例

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

{
    "EnvId": "prod-2g59lad002c864a6",
    "ServerName": "golang-h7yv",
    "TaskId": 1000
}

输出示例

{
    "Response": {
        "IsExist": false,
        "RequestId": "f72cf9c7-e477-443e-98f5-19703abbd2af",
        "Task": {
            "ChangeType": "",
            "CreateTime": "",
            "DeployType": "",
            "EnvId": "",
            "FailReason": "",
            "Id": 0,
            "OperatorRemark": "",
            "PipelineId": 0,
            "PipelineTaskId": 0,
            "PreVersionName": "",
            "ReleaseId": 0,
            "ReleaseType": "",
            "ServerName": "",
            "Status": "",
            "Steps": [],
            "VersionName": ""
        }
    }
}

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	参数错误。