文档首页/ 云数据库 RDS/ API参考/ API v3（推荐）/ 获取任务信息/ 获取任务信息 - ShowTaskDetail
更新时间：2026-06-16 GMT+08:00
查看PDF
分享

获取任务信息 - ShowTaskDetail

功能介绍

获取任务信息。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

rds:task:listAll

list

-

-

rds:task:list

-

URI

  • URI格式

    POST /v3/{project_id}/instances/{instance_id}/task-center-detail

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    是

    参数解释：

    租户在某一region下的project ID。

    获取方法请参见获取项目ID。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

    instance_id

    是

    参数解释：

    实例ID。

    可调用查询数据库实例列表接口，通过表4中的“id”获取。

    约束限制：

    不涉及。

    取值范围：

    不涉及。

    默认取值：

    不涉及。

请求参数

表2 参数说明

名称

是否必选

参数类型

说明

workflow_id

是

String

参数解释：

工作流ID。

可调用查询定时任务列表或查询即时任务列表接口，通过返回的“id”获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

workflow_name

是

String

参数解释：

工作流名称。

可调用查询定时任务列表或查询即时任务列表接口，通过返回的“name”获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

查询指定实例下的任务详情。

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/1ffc4167903840cb93a3da56d28c14fdin01/task-center-detail

{
    "workflow_id": "102772a9-31fa-4129-b9f8-7638e2792f3b",
    "workflow_name": "CreateMysqlSingleHAInstance"
}

响应消息

  • 正常响应要素说明
    表3 要素说明

    名称

    参数类型

    说明

    instance_id

    String

    参数解释：

    实例ID。

    取值范围：

    不涉及。

    instance_name

    String

    参数解释：

    实例名称。

    取值范围：

    不涉及。

    job_id

    String

    参数解释：

    任务ID。

    取值范围：

    不涉及。

    job_name

    String

    参数解释：

    任务名称。

    取值范围：

    不涉及。

    created_at

    String

    参数解释：

    任务创建时间。

    取值范围：

    不涉及。

    update_at

    String

    参数解释：

    任务更新时间。

    取值范围：

    不涉及。

    process

    String

    参数解释：

    任务进度。

    取值范围：

    不涉及。

    status

    String

    参数解释：

    任务状态。

    取值范围：

    不涉及。

    sub_task_list

    Array of objects

    参数解释：

    子任务列表。

    详见表4。
    表4 sub_task_list字段数据结构说明

    名称

    参数类型

    说明

    sub_task_name

    String

    参数解释：

    子任务名。

    取值范围：

    不涉及。

    percent

    String

    参数解释：

    子任务进度。

    取值范围：

    不涉及。

    executed_time

    String

    参数解释：

    子任务执行时间。

    取值范围：

    不涉及。

    status

    String

    参数解释：

    子任务状态。

    取值范围：

    不涉及。

    remaining_time

    String

    参数解释：

    子任务剩余预估时长。

    取值范围：

    不涉及。

    show_detail

    Boolean

    参数解释：

    是否展示已恢复库表。

    取值范围：

    不涉及。
  • 正常响应样例 
    {
    "instance_id": "1ffc4167903840cb93a3da56d28c14fdin01",
    "instance_name": "rds-mysql-2",
    "job_id": "102772a9-31fa-4129-b9f8-7638e2792f3b",
    "job_name": "CreateMysqlSingleHAInstance"
}
  • 异常响应

    请参见异常响应结果。

状态码

错误码

请参见错误码。

父主题： 获取任务信息

相关文档