Obtaining Statistics About Dedicated Resource Pool Jobs
Function
This API is used to obtain statistics about dedicated resource pool jobs.
URI
GET /v2/{project_id}/statistics/pools/{pool_name}/workloads
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID and Name. Minimum: 32 Maximum: 36 |
pool_name |
Yes |
String |
Resource pool to which a job belongs |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
statistics |
statistics object |
Job statistics |
Parameter |
Type |
Description |
|---|---|---|
total |
Integer |
Number of statistics lists |
items |
Array of WorkloadStatistics objects |
Statistics of jobs with a specific type |
Parameter |
Type |
Description |
|---|---|---|
type |
String |
Job type. Options:
|
total |
Integer |
Number of jobs |
status |
status object |
Number of jobs in different statuses |
Parameter |
Type |
Description |
|---|---|---|
Queue |
Integer |
Number of queuing jobs |
Pending |
Integer |
Number of pending jobs |
Abnormal |
Integer |
Number of abnormal jobs |
Terminating |
Integer |
Number of jobs that are being terminated |
Creating |
Integer |
Number of jobs that are being created |
Running |
Integer |
Number of running jobs |
Completed |
Integer |
Number of completed jobs |
Terminated |
Integer |
Number of terminated jobs |
Failed |
Integer |
Number of jobs that fail to be executed |
Status code: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message Minimum: 2 Maximum: 512 |
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
