全部产品
Search
文档中心

云服务器 ECS:DescribeSnapshotMonitorData

更新时间:Sep 12, 2023

调用DescribeSnapshotMonitorData查询一个地域下近30天内的快照容量变化监控数据。

接口说明

调用该接口时,您需要注意:

  • 每次最多返回400条监控数据,如果指定的参数(EndTime - StartTime)/Period大于400时,则返回错误。
  • 单次最多能查询近30天内的监控信息,如果指定的参数StartTime超过30天,则返回错误。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeSnapshotMonitorData

系统规定参数。取值:DescribeSnapshotMonitorData

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

StartTime String 2019-05-10T00:00:00Z

获取快照容量变化数据的起始时间点。按照ISO 8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。如果指定的秒(ss)不是 00,则自动换算为下一分钟。

EndTime String 2019-05-10T03:00:00Z

获取快照容量变化数据的结束时间点。按照ISO 8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。如果指定的秒(ss)不是 00,则自动换算为下一分钟。

Period Integer 60

获取快照容量变化数据的间隔时间,单位为秒。取值范围:

  • 60
  • 600
  • 3600

默认值:60。

Category String Standard

快照类型。取值范围:

  • Standard:普通快照。
  • Flash:本地快照。

默认值:Standard。

返回数据

名称

类型

示例值

描述

RequestId String 9F8163A8-F5DE-47A2-A572-4E062D223E09

请求ID。

MonitorData Array of DataPoint

快照容量变化数据的集合。

DataPoint
Size Long 243036848128

快照总容量,单位:字节(Byte)。

TimeStamp String 2019-05-10T04:00:00Z

某一快照容量数值对应的时间戳。

示例

请求示例

https://ecs.aliyuncs.com/?&Action=DescribeSnapshotMonitorData
&RegionId=cn-hangzhou
&StartTime=2019-05-10T00:00:00Z
&EndTime=2019-05-10T03:00:00Z
&Period=60
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSnapshotMonitorDataResponse>
   <MonitorData>
      <DataPoint>
         <element>
            <Size>243036848128</Size>
            <TimeStamp>2019-05-10T01:00:00Z</TimeStamp>
         </element>
         <element>
            <Size>243036848128</Size>
            <TimeStamp>2019-05-10T02:00:00Z</TimeStamp>
         </element>
         <element>
            <Size>243036848128</Size>
            <TimeStamp>2019-05-10T03:00:00Z</TimeStamp>
         </element>
      </DataPoint>
   </MonitorData>
   <RequestId>9F8163A8-F5DE-47A2-A572-4E062D223E09</RequestId>
</DescribeSnapshotMonitorDataResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "9F8163A8-F5DE-47A2-A572-4E062D223E09",
  "MonitorData" : {
    "DataPoint" : [ {
      "TimeStamp" : "2019-05-10T01:00:00Z",
      "Size" : 243036848128
    }, {
      "TimeStamp" : "2019-05-10T02:00:00Z",
      "Size" : 243036848128
    }, {
      "TimeStamp" : "2019-05-10T03:00:00Z",
      "Size" : 243036848128
    } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述

400 InvalidEndTime.Malformed The specified parameter "EndTime" is not valid. 传入的参数EndTime不符合规则。
400 InvalidParameter.TooManyDataQueried Too many data queried. 监控数据节点超出范围。
400 Throttling Request was denied due to request throttling. 请求被流控。

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