# 查询资源实时利用率 - ShowPoolRuntimeMetrics #### 功能介绍 查询资源实时利用率接口用于获取当前项目下所有资源池的实时利用率信息。该接口适用于以下场景：当用户需要监控资源使用情况、进行资源优化、容量规划或故障排查时，可通过此接口查询资源池的实时利用率，包括CPU、内存、存储等资源的使用情况。使用该接口的前提条件是用户具有访问该项目的权限，并且资源池已存在且处于运行状态。查询操作完成后，接口将返回资源池的实时利用率数据，包含利用率百分比、资源类型、时间戳等详细信息。若用户无权限、资源池不存在或系统无法获取实时数据，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ShowPoolRuntimeMetrics)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:pool:list | List | pool \* | - | - | - | | modelarts:pool:list | List | - | - g:EnterpriseProjectId - g:RequestTag/\ - g:TagKeys | - | - | #### URI GET /v2/{project_id}/metrics/runtime/pools 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | apiVersion | String | **参数解释**：资源版本。 **取值范围**：可选值如下： - os.modelarts.xxxxx/v2 | | kind | String | **参数解释**：资源类型。 **取值范围**：可选值如下： - PoolMetricsList | | items | Array of [MetricsItem] objects | **参数解释**：指标列表。 | 表3MetricsItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | table | [MetricTableItem] object | **参数解释**：资源列表。 | | metadata | [ResourceMetricsMetadata] object | **参数解释**：资源指标的元信息。 | 表4MetricTableItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | allocated | [Allocated] object | **参数解释**：已分配的资源信息。 | | capacity | [Capacity] object | **参数解释**：资源的容量信息。 | | available | [Available] object | **参数解释**：资源可用容量，不考虑资源已分配量，即资源总容量减去故障资源和热备节点的资源。 | | workload | [WorkloadInfo] object | **参数解释**：工作负载统计信息。 | 表5Allocated | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [Value] object | **参数解释**：资源量。 | | timestamp | String | **参数解释**：UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 **取值范围**：不涉及。 | | window | String | **参数解释**：统计间隔，1s表示1秒，1m表示1分钟，1h为1小时。 **取值范围**：不涉及。 | 表6Capacity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [Value] object | **参数解释**： 资源量减去故障资源量。 | | maxValue | [Value] object | **参数解释**：最大弹性资源量减去故障资源量。 | | allValue | [Value] object | **参数解释**： 资源量。 | | allMaxValue | [Value] object | **参数解释**：最大弹性资源量。 | | timestamp | String | **参数解释**：UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 **取值范围**：不涉及。 | | window | String | **参数解释**：统计间隔，1s表示1秒，1m表示1分钟，1h为1小时。 **取值范围**：不涉及。 | 表7Available | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | [Value] object | 资源量减去故障资源和热备节点的资源。 | | maxValue | [Value] object | 最大弹性资源量减去故障资源和热备节点的资源。 | | timestamp | String | UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 | | window | String | 统计间隔，1s表示1秒，1m表示1分钟，1h为1小时。 | 表8Value | 参数 | 参数类型 | 描述 | |:---|:---|:---| | cpu | String | **参数解释**：cpu量，即计算资源量。 **取值范围**：不涉及。 | | memory | String | **参数解释**：内存。 **取值范围**：不涉及。 | | tnt004 | String | **参数解释**：GPU卡的数量。 **取值范围**：不涉及。 | 表9WorkloadInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | allocated | [WorkloadStatisticsInfo] object | 已下发作业的工作负载统计。 | | queue | [WorkloadStatisticsInfo] object | 排队中的工作负载统计。 | | timestamp | String | UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 | | window | String | 统计间隔，1s表示1秒，1m表示一分钟，1h为一小时。 | 表10WorkloadStatisticsInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | infer | Integer | 旧版模型部署作业数量。 | | notebook | Integer | 开发环境作业数量。 | | train | Integer | 训练作业数量。 | | warmUpTask | Integer | 权重预热作业数量。 | | x-infer | Integer | 模型部署作业数量。 | | sum | Integer | 所有作业总和。 | 表11ResourceMetricsMetadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释**：资源指标的名称。 **取值范围**：不涉及。 | | labels | Object | **参数解释**：资源指标的标签信息 | #### 请求示例 ``` GET https://{endpoint}/v2/{project_id}/metrics/runtime/pools ``` #### 响应示例 **状态码：200** ``` { "apiVersion" : "v2", "kind" : "PoolMetricsList", "items" : [ { "table" : { "allocated" : { "value" : { "cpu" : "5", "memory" : "16Gi", "tnt004" : 1 }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" }, "available" : { "value" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "maxValue" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" }, "workload" : { "allocated" : { "infer" : 0, "train" : 2, "warmUpTask" : 1, "notebook" : 0, "x-infer" : 1, "sum" : 4 }, "queue" : { "infer" : 0, "train" : 3, "warmUpTask" : 0, "notebook" : 0, "x-infer" : 0, "sum" : 3 }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" }, "capacity" : { "value" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "maxValue" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "allValue" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "allMaxValue" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" } }, "metadata" : { "name" : "hougang-rse-pool" } } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。