DescribeTask
Queries the details of a task.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdr:DescribeTask |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TaskId |
string |
Yes |
The task ID. |
t-0005qxusucbnl5efovq9 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Progress |
integer |
The task progress, in percent. |
100 |
| Success |
boolean |
Indicates whether the task is successful. |
True |
| Message |
string |
The error message. |
successful |
| RequestId |
string |
The request ID. |
8F8A2274-F2A5-5782-89A0-7FA442BFA16B |
| UpdatedTime |
integer |
The time when the task was last updated. |
1636452195 |
| StatusCode |
string |
The status of the task. |
hdr.task.TestFailoverTask.waitStartFailover |
| Code |
string |
The return code. |
200 |
| Name |
string |
The name of the task. |
hdr.task.name.TestFailoverTask |
| TaskId |
string |
The task ID. |
t-000bzkmmlwh57miq4mwh |
| Content |
string |
The content of the task. |
- |
| CreatedTime |
integer |
The time when the task was created. |
1646100927 |
Examples
Success response
JSON format
{
"Progress": 100,
"Success": true,
"Message": "successful",
"RequestId": "8F8A2274-F2A5-5782-89A0-7FA442BFA16B",
"UpdatedTime": 1636452195,
"StatusCode": "hdr.task.TestFailoverTask.waitStartFailover",
"Code": "200",
"Name": "hdr.task.name.TestFailoverTask",
"TaskId": "t-000bzkmmlwh57miq4mwh",
"Content": "-",
"CreatedTime": 1646100927
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.