Updated on 2025-12-09 GMT+08:00

Obtaining Task Information

Function

This API is used to obtain task information.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
  • If you are using role/policy-based authorization, see Permissions and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

rds:task:listAll

list

-

-

rds:task:list

-

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

    instance_id

    Yes

    Definition

    Instance ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Description

workflow_id

Yes

String

Definition

Workflow ID.

Constraints

N/A

Range

N/A

Default Value

N/A

workflow_name

No

Integer

Definition

Workflow name.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

Query task details of a specified instance.

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

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

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    instance_id

    String

    Definition

    Instance ID.

    Range

    N/A

    instance_name

    String

    Definition

    Instance name.

    Range

    N/A

    job_id

    String

    Definition

    Task ID.

    Range

    N/A

    job_name

    String

    Definition

    Task name.

    Range

    N/A

  • Example normal response
    {
        "instance_id": "1ffc4167903840cb93a3da56d28c14fdin01",
        "instance_name": "rds-mysql-2",
        "job_id": "102772a9-31fa-4129-b9f8-7638e2792f3b",
        "job_name": "CreateMysqlSingleHAInstance"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.