All Products
Search
Document Center

Platform For AI:GetDatasetJob

Last Updated:Apr 28, 2025

Obtains a dataset job.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
DatasetIdstringYes

The dataset ID. You can call ListDatasets to obtain the dataset ID.

d-rbvg5*****jhc9ks92
DatasetJobIdstringYes

The ID of the dataset job.

dsjob-9jx1xxxxxxuj9e
DatasetVersionstringNo

The dataset version name.

v1
WorkspaceIdstringNo

The workspace ID. You can call ListWorkspaces to obtain the workspace ID.

478**

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

64B50C1D-D4C2-560C-86A3-A6ED****16D
JobActionstring

The action that is performed on the job.

Valid values:

  • SemanticIndex: semantic indexing
  • IntelligentTag: smart labeling
  • FileMetaExport: metadata export
SemanticIndex
JobModestring

The job mode.

Valid value:

  • Full: full data mode.
Full
CreateTimestring

The time when the job is started.

2024-11-15T07:06:42Z
FinishTimestring

The time when the job ends.

2024-07-16T02:03:23Z
JobSpecstring

The job details.

{\"modelId\":\"xxx\"}
Statusstring

The job state.

Valid values:

  • Succeeded
  • Failed
  • Running
  • Pending
  • PartialFailed
  • Deleting
  • ManuallyStop
Running
Descriptionstring

The job description.

Logsarray

The job logs.

Logstring

The job log.

2025-02-17 09:58:10.143 INFO: Job completed successfully.
TotalFileCountlong

The total number of job files.

1000
CompletedFileCountlong

The total number of completed files.

990
FailedFileCountlong

The total number of failed files.

10

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.