Obtaining Task Information
Function
This API is used to obtain information about a task with a specified ID. Before calling this API:
- Learn how to authenticate this API.
- Obtain the required region and endpoint.
URI
GET https://{Endpoint}/v3/{project_id}/jobs?id={id}
Parameter |
Type |
Mandatory |
Description |
---|---|---|---|
project_id |
String |
Yes |
Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. |
id |
String |
Yes |
Task ID. This parameter value indicates the asynchronous task ID returned by APIs (except APIs for applying a parameter template and creating a manual backup). |
Request Parameters
None
Response Parameters
Parameter |
Type |
Description |
---|---|---|
job |
Object |
Task information. For details, see Table 3. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Task ID. |
name |
String |
Task name. |
status |
String |
Task execution status
Value:
|
created |
String |
Creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. |
ended |
String |
End time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. |
progress |
String |
Task execution progress.
NOTE:
The execution progress (such as "60%", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned. |
instance |
Object |
Instance on which the task is executed. For details, see Table 4. |
fail_reason |
String |
Task failure information. |
Example Request
Obtaining information about a task with a specified ID
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/jobs?id=5cbb8a90-2253-4cff-8a13-49aa8f31dfb5
Example Response
Information queried.
{ "job" : { "id" : "5cbb8a90-2253-4cff-8a13-49aa8f31dfb5", "name" : "CreateGaussDBV5Instance", "status" : "Completed", "created" : "2021-07-12T09:22:04+0800", "ended" : "2021-07-12T10:10:13+0800", "progress" : "", "instance" : { "id" : "b34f8c791f2643578510c093aa2351a8in14", "name" : "gauss-c1a3" }, "fail_reason" : null } }
Status Code
- Normal
- Abnormal
For details, see Status Codes.
Error Code
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot