GetDatasetJob - Platform For AI - Alibaba Cloud Documentation Center

Retrieves a dataset job.

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

paidataset:GetDatasetJob

get

*All Resource

*

None

Request syntax

GET /api/v1/datasets/{DatasetId}/datasetjobs/{DatasetJobId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The dataset ID. For more information about how to obtain a dataset ID, see ListDatasets.	d-rbvg5*****jhc9ks92
DatasetJobId	string	Yes	The dataset job ID.	dsjob-9jx1xxxxxxuj9e

Request parameters

Parameter	Type	Required	Description	Example
DatasetVersion	string	No	The name of the dataset version.	v1
WorkspaceId	string	No	The workspace ID. For more information about how to obtain a workspace ID, see ListWorkspaces.	478**

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID.	64B50C1D-D4C2-560C-86A3-A6ED****16D
JobAction	string	The task operation. Valid values: SemanticIndex : The semantic index task. IntelligentTag : The intelligent tagging task. FileMetaExport : The metadata exporting task.	SemanticIndex
JobMode	string	The task pattern. Valid values: Full : The full pattern.	Full
CreateTime	string	The time when the task was started.	2024-11-15T07:06:42Z
FinishTime	string	The time when the task was finished.	2024-07-16T02:03:23Z
JobSpec	string	The task details.	{\"modelId\":\"xxx\"}
Status	string	The task status. Valid values: Succeeded : The task was successful. Failed : The task failed. Running : The task is running. Pending : The task is pending. PartialFailed : The task partially failed. Deleting : The task is being deleted. ManuallyStop : The task was manually stopped.	Running
Description	string	The task description.	这是一个任务描述。
Logs	array	The list of task logs.
	string	A line in the task logs.	2025-02-17 09:58:10.143 INFO: Job completed successfully.
TotalFileCount	integer	The total number of files for the task.	1000
CompletedFileCount	integer	The total number of completed files.	990
FailedFileCount	integer	The total number of failed files.	10

Examples

Success response

JSON format

{
  "RequestId": "64B50C1D-D4C2-560C-86A3-A6ED****16D",
  "JobAction": "SemanticIndex",
  "JobMode": "Full",
  "CreateTime": "2024-11-15T07:06:42Z",
  "FinishTime": "2024-07-16T02:03:23Z",
  "JobSpec": "{\\\"modelId\\\":\\\"xxx\\\"}",
  "Status": "Running",
  "Description": "这是一个任务描述。",
  "Logs": [
    "2025-02-17 09:58:10.143 INFO: Job completed successfully."
  ],
  "TotalFileCount": 1000,
  "CompletedFileCount": 990,
  "FailedFileCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.