更新时间:2024-06-06 GMT+08:00

查询资源实时利用率

功能介绍

查询当前项目下所有资源池的实时利用率。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/metrics/runtime/pools

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

用户项目ID。获取方法请参见获取项目ID和名称

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

apiVersion

String

资源版本。可选值如下:

  • os.modelarts.xxxxx/v2

kind

String

资源类型。可选值如下:

  • PoolMetricsList

items

Array of MetricsItem objects

指标列表。

表3 MetricsItem

参数

参数类型

描述

table

table object

资源列表。

metadata

ResourceMetricsMetadata object

资源指标的元信息。

表4 table

参数

参数类型

描述

allocated

Allocated object

资源已分配量。

capacity

Capacity object

资源总容量。

表5 Allocated

参数

参数类型

描述

value

Value object

资源量。

timestamp

String

UTC时间,格式yyyy-MM-dd'T'HH:mm:ss'Z'。

window

String

统计间隔,1s表示1秒,1m表示1分钟,1h为1小时。

表6 Capacity

参数

参数类型

描述

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小时。

表7 Value

参数

参数类型

描述

cpu

String

cpu量,即计算资源量。

memory

String

内存。

tnt004

String

GPU卡的数量。

表8 ResourceMetricsMetadata

参数

参数类型

描述

name

String

资源指标的名称。

labels

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。

错误码

请参见错误码