GetInstanceMetrics - 获取实例指标

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paidsw:GetInstanceMetricsget
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。如何获取实例 ID,请参见 ListInstances

dsw-730xxxxxxxxxx
MetricTypestring

实例指标类型,取值如下:

  • GpuCoreUsage:GPU 使用率。
  • GpuMemoryUsage:GPU Memory 使用率。
  • CpuCoreUsage:CPU 使用率。
  • MemoryUsage:Memory 使用率。
  • NetworkInputRate:网络写入速率。
  • NetworkOutputRate:网络写出速率。
  • DiskReadRate:磁盘读取速率。
  • DiskWriteRate:磁盘写入速率。
GpuCoreUsage
StartTimestring

获取实例指标的起始时间。

2020-11-08T15:00:00Z
EndTimestring

获取实例指标的结束时间。

2020-11-08T15:00:00Z
TimeStepstring

指标获取的时间间隔。单位为分钟。

15m

返回参数

名称类型描述示例值
object

实例指标结果。

RequestIdstring

请求 ID。

E7D55162-4489-1619-AAF5-3F97D5FCA948
Successboolean

成功标志,可能值:

  • true
  • false
true
Messagestring

返回结果说明。

"XXX"
Codestring

状态码,可能值:

  • InternalError:内部错误(除了参数验证错误外的其他错误,目前都归类到内部错误)。
  • ValidationError:参数验证错误。
null
HttpStatusCodeinteger

HTTP 状态码,可能值:

  • 400
  • 404
null
InstanceIdstring

实例 ID。

dsw-730xxxxxxxxxx
PodMetricsarray<object>

实例对应的 Pod 指标详情。

PodMetricobject

实例对应的某个 Pod 指标详情。

PodIdstring

实例对应的某个 Pod ID。

dsw-15870-695f44c5bc-hd6xm
Metricsarray<object>

实例对应的 Pod 指标。

Metricobject

获取到的 Pod 指标列表。

Timelong

该指标对应的时间戳。

1670890560
Valuefloat

指标的值。

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
        }
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-20API 内部配置变更,不影响调用查看变更详情
2022-08-30新增 OpenAPI查看变更详情