Updated on 2024-09-11 GMT+08:00

Obtaining Information About a Task

Function

This API is used to obtain task information from the task center. Before calling this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Obtaining Information About a Task with a Specified ID) before then.

URI

  • URI format

    GET https://{endpoint}/mysql/v3/{project_id}/jobs?id={id}

  • Example

    GET https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    id

    Yes

    Task ID.

Request

None

Response

  • Normal response
    Table 2 Parameter description

    Name

    Type

    Description

    job

    Object

    Task information. For details, see Table 3.

    Table 3 job field data structure description

    Name

    Type

    Description

    id

    String

    Task ID.

    name

    String

    Task name.

    status

    String

    Task execution status.

    Values:
    • Running: The task is being executed.
    • Completed: The task is successfully executed.
    • Failed: The task failed to be executed.

    created

    String

    Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    ended

    String

    End time in the "yyyy-mm-ddThh:mm:ssZ" format.

    T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the time zone offset is shown as +0800.

    process

    String

    Task execution progress.

    instance

    Object

    DB instance on which the task is executed.

    For details, see Table 4.

    entities

    Object

    Displayed information varies depending on tasks.

    For details, see Table 5.

    fail_reason

    String

    Task failure information.

    Table 4 instances field data structure description

    Name

    Type

    Description

    id

    String

    DB instance ID.

    name

    String

    DB instance name.

    Table 5 entities field data structure description

    Name

    Type

    Description

    instance

    Object

    DB instance queried in the task.

    For details, see Table 6.

    resource_ids

    List<String>

    Resource ID involved in a task.

    Table 6 entities.instance field data structure description

    Name

    Type

    Description

    endpoint

    String

    DB instance connection address.

    type

    String

    DB instance type.

    datastore

    Object

    DB information. For details, see Table 7.

    Table 7 datastore field data structure description

    Name

    Type

    Description

    type

    String

    DB engine.

    version

    String

    DB version.

    Table 8 entities field data structure description (binding or unbinding an EIP)

    Name

    Type

    Description

    public_ip

    String

    EIP used in the task.

    In the response example, some tasks in the task center are used as examples.

  • Example normal response
    {
      "job": {
        "id": "31b8ae23-c687-4d80-b7b4-42a66c9bb886",
        "name": " RestartGaussDBInstance",
        "status": "Completed",
        "created": "2018-08-06T10:41:14+0000",
        "ended": "2018-08-06T16:41:14+0000",
        "process": "",
        "instance": {
          "id": "a48e43ff268f4c0e879652d65e63d0fbin01",
          "name": "DO-NOT-TOUCH-mgr2-gaussdb"
        },
        "entities": {}
        }
    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.