查询资源实时利用率
功能介绍
查询资源实时利用率接口用于获取当前项目下所有资源池的实时利用率信息。该接口适用于以下场景:当用户需要监控资源使用情况、进行资源优化、容量规划或故障排查时,可通过此接口查询资源池的实时利用率,包括CPU、内存、存储等资源的使用情况。使用该接口的前提条件是用户具有访问该项目的权限,并且资源池已存在且处于运行状态。查询操作完成后,接口将返回资源池的实时利用率数据,包含利用率百分比、资源类型、时间戳等详细信息。若用户无权限、资源池不存在或系统无法获取实时数据,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/metrics/runtime/pools
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释:资源版本。 取值范围:可选值如下:
|
|
kind |
String |
参数解释:资源类型。 取值范围:可选值如下:
|
|
items |
Array of MetricsItem objects |
参数解释:指标列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
table |
Object |
参数解释:资源列表。 |
|
metadata |
ResourceMetricsMetadata object |
参数解释:资源指标的元信息。 |
请求示例
GET https://{endpoint}/v2/{project_id}/metrics/runtime/pools
响应示例
状态码:200
OK。
{
"apiVersion" : "v2",
"kind" : "PoolMetricsList",
"items" : [ {
"table" : {
"allocated" : {
"value" : {
"cpu" : 5,
"memory" : "15548Mi",
"tnt004" : "1073m"
},
"timestamp" : "2022-03-30T07:09:10Z",
"window" : "1m"
},
"capacity" : {
"value" : {
"cpu" : 16,
"memory" : "64Gi",
"tnt004" : 2
},
"maxValue" : {
"cpu" : 16,
"memory" : "64Gi",
"tnt004" : 2
},
"timestamp" : "2022-03-30T07:09:10Z",
"window" : "1m"
}
},
"metadata" : {
"name" : "hougang-rse-pool"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
错误码
请参见错误码。