资源池监控 - ShowPoolMonitor
功能介绍
资源池监控接口用于获取指定资源池的实时或历史监控信息。该接口适用于以下场景:当需要实时查看资源池的资源使用情况、性能状态或历史数据时,用户可通过此接口获取资源池的监控数据。使用该接口的前提条件是资源池已存在且用户具有管理员权限。调用接口成功后,系统将返回资源池的监控信息,包括资源使用率、性能指标及历史趋势等数据。若资源池不存在、用户无权限操作或资源池当前不可用,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts:pool:get
Read
pool *
g:ResourceTag/<tag-key>
-
-
-
g:EnterpriseProjectId
URI
GET /v2/{project_id}/pools/{pool_name}/monitor
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID,获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| pool_name | 是 | String | 参数解释:资源池的ID,取值自资源池详情的metadata.name字段。 约束限制:不涉及。 取值范围:只能以小写字母开头,数字、中划线组成,不能以中划线结尾,且长度为[36-63]个字符。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| time_range | 否 | String | 参数解释:查询资源池监控信息的时间范围,格式为startTimeInMillis.endTimeInMillis.durationInMinutes。其中,startTimeInMillis表示查询的开始时间,格式为UTC毫秒,如果指定为-1,服务端将按(endTimeInMillis - durationInMinutes * 60 * 1000)计算开始时间。endTimeInMillis表示查询的结束时间,格式为UTC毫秒,如果指定为-1,服务端将按(startTimeInMillis + durationInMinutes * 60 * 1000)计算结束时间,如果计算出的结束时间大于当前系统时间,则使用当前系统时间。durationInMinutes表示查询时间的跨度分钟数。 取值范围大于0并且大于等于(endTimeInMillis - startTimeInMillis) / (60 * 1000) - 1。当开始时间与结束时间都设置为-1时,系统会将结束时间设置为当前时间UTC毫秒值,并按(endTimeInMillis - durationInMinutes * 60 * 1000)计算开始时间。如:-1.-1.60(表示最近60分钟)。 约束限制:单次请求中,查询时长与周期需要满足以下条件: durationInMinutes * 60 / period <= 1440。 取值范围:不涉及。 默认取值:-1.-1.60。 查询时间范围,默认值“-1.-1.60”。格式为startTimeInMillis.endTimeInMillis.durationInMinutes,参数解释:
当开始时间与结束时间都设置为-1时,系统会将结束时间设置为当前时间UTC毫秒值,并按(endTimeInMillis - durationInMinutes * 60 * 1000)计算开始时间。如:-1.-1.60(表示最近60分钟)约束:单次请求中,查询时长与周期需要满足以下条件: durationInMinutes * 60 / period <= 1440。 |
| statistics | 否 | String | 参数解释:资源池监控信息在指定时间粒度下的统计方式。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:maximum。 |
| period | 否 | String | 参数解释:查询资源池监控信息的时间粒度,以秒为单位。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:60。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| metrics | Array of metrics objects | 参数解释:资源池的监控指标数据。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| metric | metric object | 参数解释:监控指标描述。 |
| dataPoints | Array of dataPoints objects | 参数解释:监控指标数据。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| dimensions | Array of dimensions objects | 参数解释:指标维度信息。 |
| metricName | String | 参数解释:指标名称。 取值范围:可选值如下:
|
| namespace | String | 参数解释:指标命名空间。 取值范围:可选值如下:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释:指标维度名称。 取值范围:指标名称。可选值如下:
|
| value | String | 参数解释:指标维度取值。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| timestamp | Integer | 参数解释:指标数据时间戳,以毫秒为单位。 取值范围:不涉及。 |
| unit | String | 参数解释:指标数据单位。 取值范围:可选值如下:
|
| statistics | Array of statistics objects | 参数解释:指标数据值。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| statistic | String | 参数解释:资源池监控信息在指定时间粒度下的统计方式。 取值范围:可选值如下:
|
| value | Float | 参数解释:指标数据的值,值为-1时表示无该指标数据。 取值范围:不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释:ModelArts错误码。 取值范围:不涉及。 |
| error_msg | String | 参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
查询资源池监控信息。
GET https://{endpoint}/v2/{project_id}/pools/{pool_name}/monitor
{ } 响应示例
状态码:200
OK。
{
"metrics" : [ {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "cpuUsage",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 7.944
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 7.88
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "memUsedRate",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 13.83
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 13.836
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "gpuUtil",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "gpuMemUsage",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "npuUtil",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "npuMemUsage",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "",
"statistics" : [ {
"statistic" : "average",
"value" : -1
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "diskAvailableCapacity",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Megabytes",
"statistics" : [ {
"statistic" : "average",
"value" : 834383.4
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Megabytes",
"statistics" : [ {
"statistic" : "average",
"value" : 834379.2
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "diskCapacity",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Megabytes",
"statistics" : [ {
"statistic" : "average",
"value" : 1105920
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Megabytes",
"statistics" : [ {
"statistic" : "average",
"value" : 1105920
} ]
} ]
}, {
"metric" : {
"dimensions" : [ {
"name" : "clusterId",
"value" : "83df17f1-d74c-11ec-a070-0255ac1000c3"
} ],
"metricName" : "diskUsedRate",
"namespace" : "PAAS.AGGR"
},
"dataPoints" : [ {
"timestamp" : 1655193600000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 24.553
} ]
}, {
"timestamp" : 1655197200000,
"unit" : "Percent",
"statistics" : [ {
"statistic" : "average",
"value" : 24.553
} ]
} ]
} ]
} 状态码:404
Not Found。
{
"error_code" : "ModelArts.50015001",
"error_msg" : "pool not found"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 404 | Not Found。 |
错误码
请参见错误码。