Wang , Deng Ke a8436b1d56 gaussdb API Initial version

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>

2022-11-24 13:34:54 +00:00

23 KiB

Raw Blame History

Obtaining Task Information

Function

This API is used to obtain task information from the task center.

Learn how to authorize and authenticate this API before using it.
Before calling this API, obtain the required region and endpoint.

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.

**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. Valid value: Running: The task is being executed. Completed: The task is successfully executed. Failed: The task fails 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.
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.

Parent topic: API

23 KiB Raw Blame History