Query & Filter Dataset Jobs via ListDatasetJobs API - Platform For AI - Alibaba Cloud - Platform For AI

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

get

*All Resource

*

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
DatasetId	string	Yes	The ID of the dataset. To obtain this ID, see ListDatasets.	d-lfd60v0p****ujtsdx

Request parameters

Parameter	Type	Required	Description	Example
DatasetVersion	string	No	The name of the dataset version.	v1
WorkspaceId	string	No	The ID of the workspace. To obtain this ID, see ListWorkspaces.	1234
JobAction	string	No	The job action.	SemanticIndex
PageNumber	integer	No	The page number. Pages are 1-indexed. Default: 1.	1
PageSize	integer	No	The number of entries per page.	50
Status	string	No	The job status. Valid values: Succeeded : Succeeded Failed : Failed Starting : Starting Running : Running Deleted : Deleted Pending : Pending PartialFailed : PartialFailed Deleting : Deleting ManuallyStop : ManuallyStop	Running
Order	string	No	The order in which to sort the results. This parameter is used with `SortBy`. Default: DESC. ASC: ascending order. DESC: descending order.	DESC
SortBy	string	No	The field by which to sort the results. By default, the results are sorted by `CreateTime` in descending order. Valid values: Status : Status JobAction : JobAction FinishTime : FinishTime CreateTime : CreateTime	CreateTime

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	8D7B2E70-F770-505B-A672-09F1D8F2EC1E
TotalCount	integer	The total number of jobs.	1
DatasetJobs	array	A list of dataset jobs.
	DatasetJob	The details of a dataset job.

Examples

Success response

JSON format

{
  "RequestId": "8D7B2E70-F770-505B-A672-09F1D8F2EC1E",
  "TotalCount": 1,
  "DatasetJobs": [
    {
      "DatasetJobId": "dsjob-9jx1*****uj9e",
      "JobAction": "SemanticIndex",
      "CreateTime": "2023-06-20T04:05:59Z",
      "FinishTime": "2023-06-20T06:03:48Z",
      "Status": "Running",
      "Description": "这是一个数据集任务描述。",
      "JobMode": "Full",
      "JobSpec": "{\\\"modelId\\\":\\\"xxx\\\"}",
      "Logs": [
        "2025-02-17 09:58:10.143 INFO: Job completed successfully."
      ],
      "TotalFileCount": 1000,
      "CompletedFileCount": 990,
      "FailedFileCount": 10,
      "DatasetVersion": "v1",
      "WorkspaceId": "145883"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.