云数据库 KeeWiDB
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云数据库 KeeWiDB > API 文档 > 实例相关接口 > 查询异步任务结果

查询异步任务结果

最近更新时间：2024-03-12 01:36:55

我的收藏

本页目录：

1. 接口描述

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

本接口（DescribeTaskInfo）用于查询异步任务结果。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeTaskInfo。
Version 是 String 公共参数，本接口取值：2022-03-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
TaskId 是 Integer 任务 ID。
示例值：155684

3. 输出参数

参数名称 类型 描述
Status String 任务状态。
  • preparing：待执行。
  • running：执行中。
  • succeed：成功。
  • failed：失败。
  • error：执行出错。

示例值：succeed
StartTime String 任务开始时间。
示例值：2018-11-01 17:25:14
TaskType String 任务类型。
示例值：实例清空流程
InstanceId String 实例的ID。
示例值：kee-09u2u96z
TaskMessage String 任务信息，错误时显示错误信息。执行中与成功则为空值。
示例值：ok
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

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

{
    "TaskId": "1634784500"
}

输出示例

{
    "Response": {
        "InstanceId": "kee-97ww****",
        "RequestId": "52fa67f2-4b65-423d-b78b-9d37baf5e313",
        "StartTime": "2022-03-16 22:17:54",
        "Status": "succeed",
        "TaskMessage": "",
        "TaskType": ""
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误，和业务无关。
InvalidParameter.InvalidParameter 业务参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
中国站