Querying the dedicated resource pool Job List¶
Function¶
Obtain dedicated resource pool jobs.
Debugging¶
You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.
URI¶
GET /v2/{project_id}/pools/{pool_name}/workloads
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID and Name. |
pool_name | Yes | String | Namespace to which a job belongs. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
type | No | String | Service to which a job belongs. The options are as follows:
|
status | No | String | Job status. The options are as follows:
|
sort | No | String | Sorting basis field. The options are as follows:
|
ascend | No | Boolean | Indicates whether to sort data in ascending order. |
offset | No | String | Start position for pagination query. |
limit | No | Integer | Maximum number of records displayed on a page. If the value is empty or 0, the default value 500 is used. The maximum value is 500. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
apiVersion | String | API version. The options are as follows:
|
kind | String | Resource type. The options are as follows:
|
items | Array of Workload objects | Job list. |
Parameter | Type | Description |
---|---|---|
apiVersion | String | Resource version. The options are as follows:
|
kind | String | Resource type. The options are as follows:
|
type | String | Service type of a job. The options are as follows:
|
namespace | String | Name of the resource pool to which a job belongs. |
name | String | Name |
jobName | String | Upper-Layer Service Job Name |
uid | String | Job UID. |
jobUUID | String | Upper-layer service job ID. |
flavor | String | Job specifications. |
status | String | Job status. |
resourceRequirement | resourceRequirement object | Number of resource requests for running jobs. |
priority | String | Job priority |
runningDuration | Integer | Running duration of a job. |
pendingDuration | Integer | Queuing duration of a job. |
pendingPosition | Integer | Job queue position. |
createTime | Integer | Indicates the time when a job is created. |
gvk | String | Job GVK. |
hostIps | String | List of IP addresses of the nodes where the job is running. Separate the IP addresses with commas (,). |
Parameter | Type | Description |
---|---|---|
cpu | String | CPU usage |
memory | String | Memory usage |
nvidia.com/gpu | String | GPU resource usage. |
Status code: 400
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error description. |
Status code: 404
Parameter | Type | Description |
---|---|---|
error_code | String | Error code. |
error_msg | String | Error description. |
Example Requests¶
None
Example Responses¶
Status code: 400
Bad Request.
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
}
Status code: 404
Not Found.
{
"error_code" : "ModelArts.50015001",
"error_msg" : "Pool {name} not found."
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK. |
400 | Bad Request. |
404 | Not Found. |
Error Codes¶
See Error Codes.