Help Center/ ModelArts/ API Reference/ Resource Management/ Resource Pool Statistics
Updated on 2024-05-30 GMT+08:00
View PDF
Share

Resource Pool Statistics

Function

This API is used to obtain resource pool statistics.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/statistics/pools

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

workspaceId

No

String

Workspace. The default value is 0.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

statistics

statistics object

Resource pool statistics.

operationTime

String

Time when statistics are collected.
Table 4 statistics

Parameter

Type

Description

status

status object

Statistics about resource pools in different states.
Table 5 status

Parameter

Type

Description

creating

Integer

Number of resource pools that are being created.

created

Integer

Number of resource pools that are successfully created.

failed

Integer

Number of resource pools that fail to be created in the last three days. The maximum value is 500.

pending

Integer

Number of pools in waiting state, usually yearly/monthly pools that have not been paid.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Example Requests

This interface is used to query resource pool monitoring information.

GET https://{endpoint}/v2/{project_id}/pools

{ }

Example Responses

Status code: 200

OK.

{
  "statistics" : {
    "status" : {
      "created" : 3,
      "creating" : 0,
      "failed" : 1,
      "pending" : 0
    }
  },
  "operationTime" : "2022-12-05 11:15:59.329633162 +0000 UTC"
}

Status code: 500

Internal error

{
  "error_code" : "ModelArts.50005000",
  "error_msg" : "internal error"
}

Status Codes

Status Code

Description

200

OK.

500

Internal error

Error Codes

See Error Codes.

Parent topic: Resource Management