Obtaining Information About a Task with a Specified ID¶

Function¶

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

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

Constraints¶

This API is used to query asynchronous tasks of the last one month in the task center.
After a job is generated, it takes several seconds to query the job ID.

URI¶

GET /v3/{project_id}/jobs?id={id}

**Table 1** URI parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

**Table 2** Query parameters¶
Parameter	Mandatory	Type	Description
id	Yes	String	Task ID.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Response Parameters¶

Status code: 200

**Table 4** Response body parameter¶
Parameter	Type	Description
job	GetJobInfoDetail object	Task information.

**Table 5** GetJobInfoDetail¶
Parameter	Type	Description
id	String	Task ID.
name	String	Task name.
status	String	Task execution status. Value: Running: The task is being executed. Completed: The task is successfully executed. Failed: The task fails to be executed. Valid value: Running Completed Failed
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. The value is empty unless the DB instance creation is complete.
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. The value is empty unless the DB instance creation is complete.
process	String	Task execution progress. The execution progress (such as 60%) is displayed only when the task is being executed. Otherwise, "" is returned.
instance	GetJobInstanceInfoDetail object	DB instance information of the task with the specified ID.
entities	Object	Displayed information varies depending on tasks.
fail_reason	String	Task failure information.

**Table 6** GetJobInstanceInfoDetail¶
Parameter	Type	Description
id	String	DB instance ID.
name	String	DB instance name.

Status code: 400

**Table 7** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 8** Response body parameters¶
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request¶

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/jobs?id=a9767ede-fe0f-4888-9003-e843a4c90514

Example Response¶

Status code: 200

Note

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

Success.

{
  "job" : {
    "id" : "a9767ede-fe0f-4888-9003-e843a4c90514",
    "name" : "CreateMysqlInstance",
    "status" : "Completed",
    "created" : "2018-08-06T10:41:14+0800",
    "ended" : "2018-08-06T16:41:14+0000",
    "process" : "",
    "instance" : {
      "id" : "a48e43ff268f4c0e879652d65e63d0fbin07",
      "name" : "DO-NOT-TOUCH-mgr2-mysql-single"
    },
    "entities" : {
      "instance" : {
        "endpoint" : "192.168.1.203:3306",
        "type" : "Cluster",
        "datastore" : {
          "type" : "gaussdb-mysql",
          "version" : "8.0"
        }
      },
      "resource_ids" : [ "a48e43ff268f4c0e879652d65e63d0fbin07.vm", "a48e43ff268f4c0e879652d65e63d0fbin07.volume" ]
    }
  }
}

Status Code¶

For details, see Status Codes.

Error Code¶

For details, see Error Codes.

last updated: 2024-05-20 01:10