Queries the list of asynchronous tasks. You can use this operation to query the status of asynchronous tasks triggered by users, such as free certificate applications.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number. Default value: 1. |
1 |
| PageSize |
integer |
No |
The number of tasks to display per page. |
20 |
| ResourceType |
string |
No |
The resource type. |
site |
| ResourceIds |
string |
No |
The resource ID to which the task belongs, such as a site ID. You can obtain the site ID by calling the ListSites operation. |
4080****3752512 |
| TaskStatus |
string |
No |
The current status of the task. Valid values:
|
success |
| TaskType |
string |
No |
The task type. For example, the task type for applying for a free certificate is free_cert. |
free_cert |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
C370DAF1-C838-4288-A1A0-9A87633D2*** |
| AsyncTasks |
array<object> |
The task list. |
|
|
array<object> |
The task list. |
||
| Id |
integer |
The task ID. |
4081****752512 |
| UserId |
integer |
The user ID. |
1077***12880 |
| ResourceType |
string |
The resource type. |
site |
| ResourceName |
string |
The resource name. |
www.example.com |
| ResourceId |
integer |
The resource ID. |
4081****752512 |
| TaskType |
string |
The task type. |
free_cert |
| TaskStatus |
string |
The current status of the task. Valid values:
|
success |
| TaskKey |
string |
The custom identifier that is set to associate with this task. |
linke-quality-sign |
| TaskDescription |
object |
The task description. |
|
|
string |
The task description. |
{"record":"2.basic-quota-check.com"} |
|
| GmtCreate |
string |
The creation time. |
2024-09-19 09:36:46 |
| GmtModified |
string |
The last modification time. |
2024-09-19 09:37:04 |
| PageNumber |
integer |
The page number of the returned data. |
1 |
| PageSize |
integer |
The number of entries per page. Valid values: 1 to 500. Default value: 20. |
10 |
| TotalCount |
integer |
The total number of entries. |
20 |
| TotalPage |
integer |
The total number of pages. |
2 |
Examples
Success response
JSON format
{
"RequestId": "C370DAF1-C838-4288-A1A0-9A87633D2***",
"AsyncTasks": [
{
"Id": 0,
"UserId": 0,
"ResourceType": "site",
"ResourceName": "www.example.com",
"ResourceId": 0,
"TaskType": "free_cert",
"TaskStatus": "success",
"TaskKey": "linke-quality-sign",
"TaskDescription": {
"key": "{\"record\":\"2.basic-quota-check.com\"}"
},
"GmtCreate": "2024-09-19 09:36:46",
"GmtModified": "2024-09-19 09:37:04"
}
],
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 20,
"TotalPage": 2
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter | The specified parameter is invalid. | The specified parameter is invalid. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 400 | NoPermission | You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user. | You do not have permissions to access or operate on the resource.Contact your account administrator to attach the AliyunESAFullAccess policy to the current user. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.