Obtain Jobs in a Resource Pool

project_id

Yes

String

Definition: Project ID. For details, see Obtaining a Project ID and Name.

Constraints: N/A

Range: N/A

Default Value: N/A

pool_name

Yes

String

Definition: Resource pool ID. The value is obtained from the metadata.name field in the resource pool details.

Constraints: N/A

*Range: The value can contain 36 to 63 characters. It must start with a lowercase letter and cannot end with a hyphen (-). Digits and hyphens (-) are allowed.

Default Value: N/A

type

No

String

Definition: Job types based on which the resource pool job list is queried

Constraints: N/A

Range: The options are as follows:

• train: training job

• infer: inference service

• notebook: notebook job

• x-infer: new inference job

Default Value: N/A

status

No

String

Definition: Job statuses based on which the resource pool job list is queried

Constraints: N/A

Range: The options are as follows:

• Queue: jobs in the queue

• Pending: pending jobs

• Abnormal: abnormal jobs

• Terminating: jobs being terminated

• Creating: jobs being created

• Running: running jobs

• Completed: completed jobs

• Terminated: terminated jobs

• Failed: jobs that fail to be executed

Default Value: N/A

sort

No

String

Definition: Sorting criteria for querying jobs in a resource pool

Constraints: N/A

Range: The options are as follows:

• create_time: Sort jobs by creation time.

Default Value: N/A

ascend

No

Boolean

Definition: Whether jobs in a resource pool to be queried are sorted in ascending order

Constraints: This parameter must be used with the sort query parameter.

Range: The options are as follows:

• true: in ascending order

• false: in descending order

Default Value: false

offset

No

String

Definition: Offset of pagination query

Constraints: N/A

Range: 0 to 2147483647

Default Value: 0

limit

No

Integer

Definition: Number of resources returned in a single pagination query

Constraints: N/A

Range: 0 to 500

Default Value: 500

apiVersion

String

Definition: API version of the resource

Range: The options are as follows:

• v1: The current resource version is v1.

kind

String

Definition: Resource type

Range: The options are as follows:

• WorkloadList: Job list

items

Array of Workload objects

Definition: Job list in the resource pool

Range: N/A

apiVersion

String

Definition: API version of the resource

Range: The options are as follows:

• v1: The current resource version is v1.

kind

String

Definition: Resource type

Range: The options are as follows:

• Workload: Resource pool job

type

String

Definition: Service type of a job in the resource pool

Range: The options are as follows:

• train: training job

• infer: inference service

• notebook: notebook job

namespace

String

Definition: Namespace to which a job in a cluster belongs

Range: N/A

name

String

Definition: Job name

Range: N/A

jobName

String

Definition: Name of the upper-layer service to which a job belongs

Range: N/A

uid

String

Definition: Job ID

Range: N/A

jobUUID

String

Definition: ID of the upper-layer service to which a job belongs

Range: N/A

flavor

String

Definition: Resource specifications of a job

Range: N/A

status

String

Definition: Resource specifications of a job

Range: N/A

resourceRequirement

resourceRequirement object

Definition: Resource volume requested for job running

Range: N/A

priority

String

Definition: Job priority

Range: N/A

runningDuration

Integer

Definition: Duration of job running, in seconds

Range: N/A

pendingDuration

Integer

Definition: Queue time of a job, in seconds

Range: N/A

pendingPosition

Integer

Definition: Position of a job in the queue

Range: N/A

createTime

Integer

Definition: Unix timestamp of the job creation, in milliseconds

Range: N/A

gvk

String

Definition: Kubernetes resource type, group, and version of a job

Range: N/A

hostIps

String

Definition: IP addresses of the nodes where a job is running. The values are separated with commas (,).

Range: N/A

nodes

Array of WorkloadNodeVO objects

Definition: Node resource information occupied by a running job

Range: N/A

cpu

String

Definition: CPU resources used for job running

Range: N/A

memory

String

Definition: Memory resources used for job running

Range: N/A

nvidia.com/gpu

String

Definition: GPU resources used for job running

Range: N/A

huawei.com/ascend-snt3

String

Definition: snt3 NPU resources used for job running

Range: N/A

huawei.com/ascend-snt9

String

Definition: snt9 NPU resources used for job running

Range: N/A

hostIp

String

Definition: IP address of the node where a job runs

Range: N/A

npuTopologyPlacement

String

Definition: Topology of the NPU card resource usage. The value is a 16-bit binary number, where the first bit from the right indicates card 1. 1 indicates occupied, and 0 indicates idle. For example, if cards 1 and 15 are occupied in a 16-card model, the value is 0100000000000001. If cards 1 and 7 are occupied in an 8-card model, the returned value is 0000000001000001.

Range: N/A

resourceRequirement

ResourceRequirementVO object

Definition: Resources used for job running

Range: N/A

cpu

String

Definition: CPU resources used for job running.

Range: N/A

memory

String

Definition: Memory resources used for job running.

Range: N/A

nvidia.com/gpu

String

Definition: GPU resources used for job running.

Range: N/A

huawei.com/ascend-310

String

Definition: snt3 NPU resources used for job running.

Range: N/A

huawei.com/ascend-1980

String

Definition: snt9 NPU resources used for job running.

Range: N/A

error_code

String

• Definition: ModelArts error code.

Range: N/A

error_msg

String

Definition: Error message.

Range: N/A

error_code

String

• Definition: ModelArts error code.

Range: N/A

error_msg

String

Definition: Error message.

Range: N/A

200

OK.

400

Bad Request.

404

Not Found.