GetTask-阿里云帮助中心

Gets the details of an asynchronous task.

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:GetTask

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID. Call the ListInstances API to obtain this ID.	fs-cn-********
TaskId	string	Yes	The task ID. Call the ListTasks API to obtain this ID.	3

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	37D19490-AB69-567D-A852-407C94E510E9
ProjectId	string	The project ID.	3
ProjectName	string	The project name.	project_1
Type	string	The task type. OfflineToOnline: offline-to-online data synchronization ExportTrainingSet: training sample table export	OfflineToOnline
ObjectType	string	The type of the target object. ModelFeature: model feature FeatureView: feature view	ModelFeature
ObjectId	string	The ID of the target object.	3
Status	string	The status of the task. Initializing: The task is initializing. Running: The task is running. Success: The task completed successfully. Failure: The task failed.	Running
Config	string	The task configuration.	{ "mode": "overwrite", "partitions": { "dt": "20230820" }, "event_time": "", "config": {}, "offline_to_online": true }
RunningConfig	string	The task runtime configuration.	DROP TABLE IF EXISTS public.fsxxx
GmtCreateTime	string	The creation time.	2023-07-04T11:26:09.036+08:00
GmtModifiedTime	string	The update time.	2023-07-04T11:26:09.036+08:00
GmtExecutedTime	string	The execution time.	2023-07-04T11:26:09.036+08:00
GmtFinishedTime	string	The completion time.	2023-07-04T11:26:09.036+08:00

Examples

Success response

JSON format

{
  "RequestId": "37D19490-AB69-567D-A852-407C94E510E9",
  "ProjectId": "3",
  "ProjectName": "project_1",
  "Type": "OfflineToOnline",
  "ObjectType": "ModelFeature",
  "ObjectId": "3",
  "Status": "Running",
  "Config": "{\n\t\"mode\": \"overwrite\",\n\t\"partitions\": {\n\t\t\"dt\": \"20230820\"\n\t},\n\t\"event_time\": \"\",\n\t\"config\": {},\n\t\"offline_to_online\": true\n}",
  "RunningConfig": "DROP TABLE IF EXISTS public.fsxxx",
  "GmtCreateTime": "2023-07-04T11:26:09.036+08:00",
  "GmtModifiedTime": "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"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.