负载均衡
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 负载均衡 > API 文档 > 其他相关接口 > 查询异步任务状态

查询异步任务状态

最近更新时间：2024-03-12 19:50:26

我的收藏

本页目录：

1. 接口描述

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

本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTaskStatus。
Version 是 String 公共参数，本接口取值：2018-03-17。
Region 是 String 公共参数，详见产品支持的 地域列表。
TaskId 否 String 请求ID，即接口返回的 RequestId 参数。
示例值：55c85074-3e7f-4c6d-864f-673660d4f8de
DealName 否 String 订单ID。
注意：参数TaskId和DealName必须传一个。
示例值：2022XXXX

3. 输出参数

参数名称 类型 描述
Status Integer 任务的当前状态。 0：成功，1：失败，2：进行中。
示例值：0
LoadBalancerIds Array of String 由负载均衡实例唯一 ID 组成的数组。
注意：此字段可能返回 null，表示取不到有效值。
示例值：["lb-6efswuxa"]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务状态

假设某次调用创建转发规则接口返回成功，且返回的 RequestId 为 55c85074-3e7f-4c6d-864f-673660d4f8de，则需要查询该异步任务最终是否执行成功。响应中，Status 为 0 表示任务执行成功。

输入示例

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

{
    "TaskId": "55c85074-3e7f-4c6d-864f-673660d4f8de"
}

输出示例

{
    "Response": {
        "Status": 0,
        "LoadBalancerIds": [
            "lb-6efswuxa"
        ],
        "RequestId": "917384bc-5b8d-4b68-a0bc-a58f815e8e3b"
    }
}

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 参数错误。
InvalidParameter.RegionNotFound 地域无效。
中国站