GetUserViewMetrics - 获取用户维度的指标
您可以通过GetUserViewMetrics获取用户维度的指标数据。
目前该API接口已标记为弃用，推荐使用替代API：PaiStudio(2022-01-12) - GetQuotaUserViewMetrics。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/v1/resources/{ResourceGroupID}/usermetrics HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ResourceGroupID |
string |
是 |
资源组 ID，每一个资源组都有全局唯一的资源组 ID。可以通过资源组 ID 来获取资源组的信息。 |
rgf0zhfqn1d4ity2 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| WorkspaceId |
string |
否 |
工作空间 ID。 |
86995 |
| PageNumber |
string |
是 |
当前页码 |
1 |
| PageSize |
string |
是 |
分页大小 |
10 |
| SortBy |
string |
否 |
排序依据。 |
GmtModified |
| Order |
string |
否 |
排序方向：-asc：升序-desc：降序 |
DESC |
| UserId |
string |
否 |
用户主账号 ID |
123456 |
| TimeStep |
string |
否 |
时间步长，默认值：5m。支持的时长单位的取值范围：
当值不带单位时，默认使用单位：s（秒）。 |
1h |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| ResourceGroupId |
string |
资源组 ID |
rgf0zhfqn1d4ity2 |
| UserMetrics |
array |
按照用户维度统计的指标 |
|
| UserViewMetric |
按照用户维度统计的指标 |
||
| Summary | UserViewMetric |
用户监控数据。 |
|
| Total |
integer |
总条数 |
2 |
示例
正常返回示例
JSON格式
{
"ResourceGroupId": "rgf0zhfqn1d4ity2",
"UserMetrics": [
{
"ResourceGroupId": "rg17tmvwiokh****",
"TotalCPU": 1000,
"CPUUsageRate": "59",
"GPUUsageRate": "10",
"TotalMemory": 10240,
"TotalGPU": 1,
"MemoryUsageRate": "20",
"RequestCPU": 100,
"RequestGPU": 10,
"RequestMemory": 102400000,
"NetworkInputRate": "1",
"NetworkOutputRate": "1",
"DiskReadRate": "22",
"DiskWriteRate": "22",
"JobType": "PyTorch",
"UserId": "16111111****",
"CPUNodeNumber": 2,
"GPUNodeNumber": 1,
"CpuJobNames": [
"dlcxxxxx"
],
"GpuJobNames": [
"dlcyyyyy"
],
"NodeNames": [
"lrnxxxxxx"
],
"CpuNodeNames": [
"ecixxxxxx"
],
"GpuNodeNames": [
"lrnxxxxxxx"
]
}
],
"Summary": {
"ResourceGroupId": "rg17tmvwiokh****",
"TotalCPU": 1000,
"CPUUsageRate": "59",
"GPUUsageRate": "10",
"TotalMemory": 10240,
"TotalGPU": 1,
"MemoryUsageRate": "20",
"RequestCPU": 100,
"RequestGPU": 10,
"RequestMemory": 102400000,
"NetworkInputRate": "1",
"NetworkOutputRate": "1",
"DiskReadRate": "22",
"DiskWriteRate": "22",
"JobType": "PyTorch",
"UserId": "16111111****",
"CPUNodeNumber": 2,
"GPUNodeNumber": 1,
"CpuJobNames": [
"dlcxxxxx"
],
"GpuJobNames": [
"dlcyyyyy"
],
"NodeNames": [
"lrnxxxxxx"
],
"CpuNodeNames": [
"ecixxxxxx"
],
"GpuNodeNames": [
"lrnxxxxxxx"
]
},
"Total": 2
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。