DescribeMonitorData - 获取实例监控数据

获取实例监控信息(vCPU、内存、磁盘IO、流量)。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
swas-open:DescribeMonitorDataget
  • Instance
    acs:swas-open:{#regionId}:{#accountId}:instance/{#InstanceId}

请求参数

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

指定的轻量应用服务器实例所属的地域 ID。 您可以调用 ListRegions 查看支持的阿里云地域列表。

cn-hangzhou
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
InstanceIdstring

指定的轻量应用服务器的实例 ID。

2ad1ae67295445f598017499dc****
MetricNamestring

监控指标名称。可能值:

  • MEMORY_ACTUALUSEDSPACE:内存实际使用大小,单位 bytes。
  • DISKUSAGE_USED:磁盘使用大小,单位 bytes。
  • CPU_UTILIZATION:cpu 使用率,百分比。
  • VPC_PUBLICIP_INTERNETOUT_RATE:网络出带宽速率,单位 bits/s。
  • VPC_PUBLICIP_INTERNETIN_RATE:网络入带宽速率,单位 bits/s。
  • DISK_READ_IOPS:磁盘读 iops,单位:count/s。
  • DISK_WRITE_IOPS:磁盘写 iops,单位:count/s。
  • FLOW_USED:流量使用,单位 bytes。
DISKUSAGE_USED
Periodstring

时间间隔。 取值:60、300、900。 单位:秒。

说明

当 Metricname 为 FLOW_USED 时,Period 值固定为 3600s(即一小时),请根据您的实际需求设置该参数。

说明
60
StartTimestring

开始时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。
  • Format 格式:YYYY-MM-DDThh:mm:ssZ。
说明 开始和结束时间执行的是左开右闭的模式,StartTime 不能等于或大于 EndTime。 StartTime 和 EndTime 之间的间隔小于等于 31 天。
2022-09-07T04:04:44Z
EndTimestring

结束时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。
  • Format 格式:YYYY-MM-DDThh:mm:ssZ。
说明 StartTime 和 EndTime 之间的间隔小于等于 31 天。
2022-09-08T08:04:44Z
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值,初次调用无需配置。

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
Lengthstring

每页显示的记录条数,用于分页查询。取值范围:1~1440。

100

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

30637AD6-D977-4833-A54C-CC89483E****
Datapointsstring

监控数据列表。

[]
Periodstring

时间间隔。 取值:60、300、900。 单位:秒。

说明

当 Metricname 为 FLOW_USED 时,Period 值固定为 3600s(即一小时),请根据您的实际需求设置该参数。

说明
60
NextTokenstring

查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值,初次调用无需配置。

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***

示例

正常返回示例

JSON格式

{
  "RequestId": "30637AD6-D977-4833-A54C-CC89483E****",
  "Datapoints": "[]",
  "Period": "60",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***\n"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request.内部错误,请重试。如果多次尝试失败,请提交工单。

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