Jump to

• Request
• Response

Get task runs

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns

Returns a list of tasks run in an AI Data Platform Workbench.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• jobRunKey(required): string
  The field to filter based on job run key.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• parentJobRunKey: string
  The field to filter based on parent job run key.
• rootJobRunKey: string
  The field to filter based on root job run key.
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName", "status" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]
• status: array[string]
  The field to filter based on state.

  • Allowed Values: [ "PENDING", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. A list of run tasks is retrieved.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : TaskRunCollection

Type: object

List of TaskRuns.

Show Source

• items(required): array items
  List of TaskRuns.

{
    "description":"List of TaskRuns.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of TaskRuns.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskRunSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of TaskRuns.

Show Source

• Array of: object TaskRunSummary
  Summary information about a TaskRun.

{
    "description":"List of TaskRuns.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskRunSummary"
    }
}

Nested Schema : TaskRunSummary

Type: object

Summary information about a TaskRun.

Show Source

• clusterValidationStartTime: integer(int64)
  The time at which the cluster validation started in epoch milliseconds.
• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• externalId: string
  The external ID of the task execution.
• jobRunKey: string
  The OCID of the job.
• key: string
  The OCID of the TaskRun.
• name: string
  A user-friendly name. Does not have to be unique, and is changeable.
• parentJobRunKey: string
  The OCID of the job.
• retryAttempt: integer(int32)
  Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.
• rootJobRunKey: string
  The OCID of the job.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• state: object State
  The current state of the run.
• taskKey: string
  Minimum Length: 1

  Maximum Length: 100

  The display name of the task. User can specify a value for this.

{
    "description":"Summary information about a TaskRun.",
    "type":"object",
    "properties":{
        "key":{
            "description":"The OCID of the TaskRun.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "taskKey":{
            "description":"The display name of the task. User can specify a value for this.",
            "minLength":1,
            "maxLength":100,
            "type":"string"
        },
        "jobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "parentJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "rootJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "clusterValidationStartTime":{
            "description":"The time at which the cluster validation started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "externalId":{
            "description":"The external ID of the task execution.",
            "type":"string"
        },
        "retryAttempt":{
            "description":"Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : State

Type: object

The current state of the run.

Show Source

• errorTrace: string
  If there was an error executing the run, this field contains any available stack traces.
• isUserCanceledOrTimedOut: boolean
  Default Value: false

  Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.
• stateMessage: string
  A descriptive message of the current state.
• status: string
  Allowed Values: [ "PENDING", "QUEUED", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELING", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED", "TIMED_OUT", "PAUSED_MAINTENANCE" ]

  Current state of execution.

{
    "description":"The current state of the run.",
    "type":"object",
    "properties":{
        "status":{
            "description":"Current state of execution.",
            "type":"string",
            "enum":[
                "PENDING",
                "QUEUED",
                "RUNNING",
                "SKIPPED",
                "INTERNAL_ERROR",
                "BLOCKED",
                "SUCCESS",
                "FAILED",
                "CANCELING",
                "CANCELED",
                "UPSTREAM_CANCELED",
                "UPSTREAM_FAILED",
                "EXCLUDED",
                "TIMED_OUT",
                "PAUSED_MAINTENANCE"
            ]
        },
        "stateMessage":{
            "description":"A descriptive message of the current state.",
            "type":"string"
        },
        "errorTrace":{
            "description":"If there was an error executing the run, this field contains any available stack traces.",
            "type":"string"
        },
        "isUserCanceledOrTimedOut":{
            "description":"Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.",
            "type":"boolean",
            "default":false
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top