Querying the Real-Time Resource Usage¶
Function¶
Obtain the real-time usage of all resource pools in the current project.
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}/metrics/runtime/pools
Parameter | Mandatory | Type | Description |
---|---|---|---|
project_id | Yes | String | Project ID. For details, see Obtaining a Project ID and Name. |
Request Parameters¶
None
Response Parameters¶
Status code: 200
Parameter | Type | Description |
---|---|---|
apiVersion | String | Resource version. |
kind | String | Resource type. The options are as follows:
|
items | Array of MetricsItem objects | Metric list |
Parameter | Type | Description |
---|---|---|
table | table object | Indicates the resource list. |
metadata | ResourceMetricsMetadata object | Indicates the metadata of a resource indicator. |
Parameter | Type | Description |
---|---|---|
allocated | Allocated object | Allocated Resources |
capacity | Capacity object | Total Resource Capacity |
Parameter | Type | Description |
---|---|---|
value | Value object | Resource amount. |
timestamp | String | UTC time, in the format yyyy-MM-dd'T'HH:mm:ss'Z'. |
window | String | Statistics interval. 1s indicates 1 second, 1m indicates 1 minute, and 1h indicates 1 hour. |
Parameter | Type | Description |
---|---|---|
value | Value object | Number of resources. |
maxValue | Value object | Maximum number of elastic resources. |
timestamp | String | UTC time. The format is yyyy-MM-dd'T'HH:mm:ss'Z'. |
window | String | Statistical interval. 1s indicates 1 second, 1m indicates 1 minute, and 1h indicates 1 hour. |
Parameter | Type | Description |
---|---|---|
cpu | String | Number of CPUs |
memory | String | Memory |
nvidia.com/t4 | String | t4 volume |
Parameter | Type | Description |
---|---|---|
name | String | Name of a resource indicator. |
labels | Object | Indicates the tag information of a resource metric. |
Example Requests¶
None
Example Responses¶
Status code: 200
OK.
{
"apiVersion" : "v2",
"kind" : "PoolMetricsList",
"items" : [ {
"table" : {
"allocated" : {
"value" : {
"cpu" : 5,
"memory" : "15548Mi",
"nvidia.com/t4" : "1073m"
},
"timestamp" : "2022-03-30T07:09:10Z",
"window" : "1m"
},
"capacity" : {
"value" : {
"cpu" : 16,
"memory" : "64Gi",
"nvidia.com/t4" : 2
},
"maxValue" : {
"cpu" : 16,
"memory" : "64Gi",
"nvidia.com/t4" : 2
},
"timestamp" : "2022-03-30T07:09:10Z",
"window" : "1m"
}
},
"metadata" : {
"name" : "hougang-rse-pool"
}
} ]
}
Status Codes¶
Status Code | Description |
---|---|
200 | OK. |
Error Codes¶
See Error Codes.