ListTasks-阿里云帮助中心

Lists asynchronous tasks for an instance, supporting pagination and filtering by project, object type, and status.

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

featurestore:ListTasks

list

*All Resource

*

None

Request syntax

GET /api/v1/instances/{InstanceId}/tasks HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. You can obtain it by calling the ListInstances interface.	fs-cn-********

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	string	No	The ID of the project. You can call the ListProjects operation to obtain the ID.	4
ObjectType	string	No	The type of the object. ● `ModelFeature`: a model feature. ● `FeatureView`: a feature view.	ModelFeature
ObjectId	string	No	The ID of the object. You can call the ListModelFeatures or ListFeatureViews operation to obtain the ID.	4
Status	string	No	The task status. ● `Initializing`: The task is being initialized. ● `Running`: The task is running. ● `Success`: The task is successful. ● `Failure`: The task fails.	Running
PageSize	integer	No	The number of entries per page. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
Type	string	No	The task type by which to filter tasks.	OfflineToOnline
TaskIds	array	No	The task IDs by which to filter tasks.
	string	No	The ID of the task. You can call the ListTasks operation to obtain the ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C33E160C-BFCA-5719-B958-942850E949F6
TotalCount	integer	The total number of tasks.	10
Tasks	array<object>	The list of tasks.
	object	A task.
GmtCreateTime	string	The time when the task was created.	2023-07-04T11:26:09.036+08:00
GmtExecutedTime	string	The time when the task was executed.	2023-07-04T11:26:09.036+08:00
GmtFinishedTime	string	The time when the task was completed.	2023-07-04T11:26:09.036+08:00
ObjectId	string	The ID of the object.	5
ObjectType	string	The type of the object. Valid values: ● ModelFeature: a model feature. ● FeatureView: a feature view.	ModelFeature
ProjectId	string	The project ID.	4
ProjectName	string	The project name.	project_1
Status	string	The status of the task. Valid values: ● Initializing: The task is being initialized. ● Running: The task is in progress. ● Success: The task is successful. ● Failure: The task failed.	Running
TaskId	string	The task ID.	4
Type	string	The task type. Valid values: ● OfflineToOnline: The task synchronizes data from offline to online. ● ExportTrainingSet: The task exports a training set.	OfflineToOnline

Examples

Success response

JSON format

{
  "RequestId": "C33E160C-BFCA-5719-B958-942850E949F6",
  "TotalCount": 10,
  "Tasks": [
    {
      "GmtCreateTime": "2023-07-04T11:26:09.036+08:00",
      "GmtExecutedTime": "2023-07-04T11:26:09.036+08:00",
      "GmtFinishedTime": "2023-07-04T11:26:09.036+08:00",
      "ObjectId": "5",
      "ObjectType": "ModelFeature",
      "ProjectId": "4",
      "ProjectName": "project_1",
      "Status": "Running",
      "TaskId": "4",
      "Type": "OfflineToOnline"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.