云桌面获取实例监控数据

1. 接口描述

接口请求域名： cvd.tencentcloudapi.com 。

查询实例监控数据

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceMonitorData。
Version	是	String	公共参数，本接口取值：2020-11-04。
Region	否	String	公共参数，本接口不需要传递此参数。
Instances.N	是	Array of Instance	实例维度组合数组
NameSpace	是	String	命名空间。如QCE/CVM、QCE/BLOCK_STORAGE等示例值：QCE/CVM
MetricName	是	String	指标名示例值：CPUUsage
Period	否	Integer	统计周期(时间粒度), 单位s。示例值：300
StartTime	否	String	开始时间示例值：2019-03-24T10:50:00+08:00
EndTime	否	String	结束时间示例值：2019-03-24T20:50:00+08:00
SpecifyStatistics	否	Integer	多种统计方式数据。avg, max, min (1,2,4)可以自由组合示例值：1

3. 输出参数

参数名称	类型	描述
MetricName	String	指标名示例值：CPUUsage
Period	Integer	统计周期示例值：300
StartTime	String	开始时间示例值：2019-03-24T10:50:00+08:00
EndTime	String	结束时间示例值：2019-03-24T20:50:00+08:00
DataPoints	Array of DataPoint	数据点数组
Msg	String	message信息示例值：ok
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeInstanceMonitorData

输入示例

POST / HTTP/1.1
Host: cvd.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceMonitorData
<公共请求参数>

{
    "NameSpace": "QCE/CVM",
    "MetricName": "CpuUsage",
    "Period": 300,
    "Instances": [
        {
            "Dimensions": [
                {
                    "Name": "InstanceId",
                    "Value": "cdi-xxxx"
                }
            ]
        }
    ],
    "StartTime": "2018-09-22T19:23:07+08:00",
    "EndTime": "2018-09-22T20:23:07+08:00"
}

输出示例

{
    "Response": {
        "StartTime": "2018-09-22T19:20:00+08:00",
        "EndTime": "2018-09-22T20:20:00+08:00",
        "Period": 300,
        "MetricName": "CpuUseRate",
        "DataPoints": [
            {
                "Dimensions": [
                    {
                        "Name": "InstanceId",
                        "Value": "cdi-xxxx"
                    }
                ],
                "Timestamps": [],
                "Values": []
            }
        ],
        "RequestId": "2bcfe8b7-8ea8-4488-9d17-f1aeb106eecd"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InvalidParameter	参数错误。

获取实例监控数据

本页目录：