QueryTaskList-阿里云帮助中心

Queries a list of offline tasks.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dytns:QueryTaskList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	No	The task name.	Example
TagId	integer	No	The tag ID. You can call the QueryTagListPage operation to query tag IDs.	15
TaskId	integer	No	The task ID. You can call the DescribeTasks operation to query the list of task IDs.	91
PageSize	integer	No	The page size. Maximum value: 1000.	10
CurrentPage	integer	No	The current page number.	80
TaskType	array	No	An array of task types.
	integer	No	0: Filter task 1: Sort task 2: Batch task	[0]
Result	array	No	The task statuses.
	integer	No	0: Running 1: Succeeded 2: Failed	[0]

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	68A40250-50CD-034C-B728-0BD******177
Message	string	The status code description.	OK
Data	object	The response data.
TotalCount	integer	The total count.	22
Data	array	The details of the tasks.
	string	The details of a task, returned as a JSON string.	{"createDate":"创建时间"}
PageNo	integer	The current page number.	62
Code	string	The request status code. Valid values: OK: The request was successful. isv.INVALID_PARAMETERS: The specified parameter is invalid. isp.SYSTEM_ERROR: A system error occurred. Note For more information, see the "Error codes" section of this topic.	OK

Examples

Success response

JSON format

{
  "RequestId": "68A40250-50CD-034C-B728-0BD******177",
  "Message": "OK",
  "Data": {
    "TotalCount": 22,
    "Data": [
      "{\"createDate\":\"创建时间\"}"
    ],
    "PageNo": 62
  },
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.