查询异步任务信息

最近更新时间:2026-07-07 10:58:07

我的收藏

1. 接口描述

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

异步任务查询接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAsyncJobs。
Version String 公共参数,本接口取值:2025-10-30。
Region String 公共参数,详见产品支持的 地域列表
MaxResults Integer 分批次查询时每次显示的条目数。取值范围:1~100,默认值:20。
示例值:20
NextToken String 是否拥有下一次查询的令牌(Token)。取值: 第一次查询和没有下一次查询时,均无需填写。 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
示例值:FFmyTO70tTpLG6I3FmYAXGKPd8r6k
RequestIds.N Array of String 异步请求返回的RequestId列表
示例值:["a5c5d5d5-d5d5-4d5d-8d5d-d5d5d5d5d5d5"]

3. 输出参数

参数名称 类型 描述
Jobs Array of Job 任务列表。
MaxResults Integer 分批次查询时每次显示的条目数。
示例值:20
NextToken String 是否拥有下一次查询的令牌(Token)。取值: 如果 NextToken 为空表示没有下一次查询。 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
示例值:FFmyTO70tTpLG6I3FmYAXGKPd8r6k
TotalCount Integer 列表条目数。
示例值:100
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务信息

输入示例

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

{
    "RequestIds": [
        "c318a537-9bfa-40c2-b6d5-e6f872ad4b1f"
    ]
}

输出示例

{
    "Response": {
        "Jobs": [
            {
                "ApiName": "DisassociateBandwidthPackageFromLoadBalancer",
                "RequestId": "c318a537-9bfa-40c2-b6d5-e6f872ad4b1f",
                "ResourceIds": [
                    "alb-f8q2xk9m"
                ],
                "Status": "Succeeded"
            }
        ],
        "MaxResults": 20,
        "NextToken": "",
        "TotalCount": 1,
        "RequestId": "e4bf85e4-739f-4a3e-9ce1-d98d1fa2a876"
    }
}

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 参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。