调用GetInstanceMetrics获取实例指标_人工智能平台 PAI(PAI)-阿里云帮助中心

获取实例运行的资源指标。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/instance/{InstanceId}/metrics

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。如何获取实例 ID，请参见 ListInstances 。	dsw-730xxxxxxxxxx
MetricType	string	是	实例指标类型，取值如下： GpuCoreUsage：GPU 使用率。 GpuMemoryUsage：GPU Memory 使用率。 CpuCoreUsage：CPU 使用率。 MemoryUsage：Memory 使用率。 NetworkInputRate：网络写入速率。 NetworkOutputRate：网络写出速率。 DiskReadRate：磁盘读取速率。 DiskWriteRate：磁盘写入速率。	GpuCoreUsage
StartTime	string	否	获取实例指标的起始时间。	2020-11-08T15:00:00Z
EndTime	string	否	获取实例指标的结束时间。	2020-11-08T15:00:00Z
TimeStep	string	否	指标获取的时间间隔。单位为分钟。	15m

返回参数

名称	类型	描述	示例值
	object	实例指标结果。
RequestId	string	请求 ID。	E7D55162-4489-1619-AAF5-3F97D5FCA948
Success	boolean	成功标志，可能值： true false	true
Message	string	返回结果说明。	"XXX"
Code	string	状态码，可能值： InternalError：内部错误（除了参数验证错误外的其他错误，目前都归类到内部错误）。 ValidationError：参数验证错误。	null
HttpStatusCode	integer	HTTP 状态码，可能值： 400 404	null
InstanceId	string	实例 ID。	dsw-730xxxxxxxxxx
PodMetrics	array<object>	实例对应的 Pod 指标详情。
	object	实例对应的某个 Pod 指标详情。
PodId	string	实例对应的某个 Pod ID。	dsw-15870-695f44c5bc-hd6xm
Metrics	array<object>	实例对应的 Pod 指标。
	object	获取到的 Pod 指标列表。
Time	long	该指标对应的时间戳。	1670890560
Value	float	指标的值。	25.901031

示例

正常返回示例

JSON格式

{
  "RequestId": "E7D55162-4489-1619-AAF5-3F97D5FCA948",
  "Success": true,
  "Message": "\"XXX\"",
  "Code": "null",
  "HttpStatusCode": 0,
  "InstanceId": "dsw-730xxxxxxxxxx",
  "PodMetrics": [
    {
      "PodId": "dsw-15870-695f44c5bc-hd6xm",
      "Metrics": [
        {
          "Time": 1670890560,
          "Value": 25.901031
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2022-08-30	新增 OpenAPI	查看变更详情