查询异步任务的执行结果

最近更新时间:2024-03-12 01:13:44

我的收藏

1. 接口描述

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

本接口(DescribeAsyncRequestInfo)用于查询云数据库实例异步任务的执行结果。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAsyncRequestInfo。
Version String 公共参数,本接口取值:2017-03-20。
Region String 公共参数,详见产品支持的 地域列表
AsyncRequestId String 异步任务的请求 ID。
示例值:f96e4f3c-8fc96c86-2ec79ac8-cb63a7a7

3. 输出参数

参数名称 类型 描述
Status String 任务执行结果。可能的取值:INITIAL - 初始化,RUNNING - 运行中,SUCCESS - 执行成功,FAILED - 执行失败,KILLED - 已终止,REMOVED - 已删除,PAUSED - 终止中。
注意:此字段可能返回 null,表示取不到有效值。
示例值:SUCCESS
Info String 任务执行信息描述。
注意:此字段可能返回 null,表示取不到有效值。
示例值:删除库表成功
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务的执行结果

输入示例

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

{
    "AsyncRequestId": "f96e4f3c-8fc96c86-2ec79ac8-cb63a7a7"
}

输出示例

{
    "Response": {
        "Info": "删除库表成功",
        "Status": "SUCCESS",
        "RequestId": "faae8d6a-38fb-44de-988e-5a0e78aba4a7"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
CdbError.TaskError 后端任务错误。
InternalError.FtpError 文件传输异常。
InternalError.UndefinedError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidAsyncRequestId 异步任务不存在。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy 用户没有该策略权限。