DescribeInstanceCpuMonitor

1. 接口描述

调用本接口用于查询实例指定时间段内的Cpu使用率。

注意事项

开始时间和结束时间的跨度不能超过24小时。
只能查询近24小时内的Cpu使用率。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

必选

类型

描述

instanceId

是

String

实例ID。

startTime

是

String

查询开始时间。

按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。

endTime

是

String

查询结束时间。

按照ISO8601标准表示，并且使用UTC时间。格式为：YYYY-MM-DDThh:mm:ssZ。

3. 响应结果

名称

类型

描述

requestId

String

唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 requestId。

dataList

Array of InstanceCpuMonitorData

带宽CPU使用率列表。

4. 代码示例

查询实例一段时间内的Cpu使用率。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeInstanceCpuMonitor
<Common Request Params>

Request:
{
  "instanceId": "932237369560662463",
  "startTime": "2023-07-12T00:00:00Z",
  "endTime": "2023-07-12T01:00:00Z"
}

Response:
{
  "requestId": "T1B3DDE46-6FAA-4380-80A2-842F1B3186B7",
  "response": {
    "requestId": "T1B3DDE46-6FAA-4380-80A2-842F1B3186B7",
    "dataList": [
      {
        "cpu": "0.0089",
        "time": "2023-07-12T00:00:00Z"
      },
      {
        "cpu": "0.0083",
        "time": "2023-07-12T00:05:00Z"
      },
      {
        "cpu": "0.0082",
        "time": "2023-07-12T00:10:00Z"
      },
      {
        "cpu": "0.0085",
        "time": "2023-07-12T00:15:00Z"
      },
      {
        "cpu": "0.0067",
        "time": "2023-07-12T00:20:00Z"
      },
      {
        "cpu": "0.0068",
        "time": "2023-07-12T00:25:00Z"
      },
      {
        "cpu": "0.0079",
        "time": "2023-07-12T00:30:00Z"
      },
      {
        "cpu": "0.0094",
        "time": "2023-07-12T00:35:00Z"
      },
      {
        "cpu": "0.0092",
        "time": "2023-07-12T00:40:00Z"
      },
      {
        "cpu": "0.0088",
        "time": "2023-07-12T00:45:00Z"
      },
      {
        "cpu": "0.0090",
        "time": "2023-07-12T00:50:00Z"
      },
      {
        "cpu": "0.0090",
        "time": "2023-07-12T00:55:00Z"
      }
    ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_INSTANCE_NOT_FOUND

指定的实例不存在。

403

INVALID_START_TIME_MUST_BEFORE_END_TIME

开始时间必须在结束时间之前。

403

INVALID_TIME_RANGE

无效的时间跨度。

403

TIME_OUT_OF_RANGE

超出可查询的时间范围。

最后更新于8个月前