查询桌面使用时长详情-APIs-Tencent Cloud

1. 接口描述

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

拉取实例使用时长详情

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUsage。
Version	是	String	公共参数，本接口取值：2020-11-04。
Region	否	String	公共参数，本接口不需要传递此参数。
StartTime	是	Integer	查询起始时间，最小不能超过当前时间 90 天前，取 unix 时间戳示例值：1735660800
EndTime	是	Integer	查询截止时间，取 unix 时间戳示例值：1735747200
PageSize	否	Integer	每页查询信息条数，默认 20，最大 100 示例值：20
PageNumber	否	Integer	页号，起始页为 1，不填默认为 1 示例值：1
QueryKey	否	String	查询key，每次查询会返回示例值：-d298-4c88-b7ff-0eabf528d566
Filters.N	否	Array of Filter	查询条件，Name可选为： InstanceId按照实例ID搜索 UserName按照绑定的用户搜索，只取Values的第一个值 ChareType按照计费类型搜索 InstanceType按照实例类型搜索
SortType	否	Integer	指定的排序方式，默认不排序 1:使用时间，升序 2:使用时间，降序 3:空闲时间，升序 4:空闲时间，降序示例值：0

3. 输出参数

参数名称	类型	描述
Total	Integer	检索出相关使用详情总数示例值：1
QueryKey	String	查询 key，作为翻页查询入参示例值：-d298-4c88-b7ff-0eabf528d566
UsageSet	Array of Usage	使用时长详情
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeUsage

输入示例

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

{
    "PageSize": 20,
    "PageNumber": 1,
    "StartTime": 1735660800,
    "EndTime": "1735747200"
}

输出示例

{
    "Response": {
        "UsageSet": [
            {
                "InstanceId": "cdi-sd8dhw8osu0jcw6",
                "Name": "test-cvd",
                "Status": "RUNNING",
                "UserName": "test-user",
                "ChargeType": "PREPAID",
                "InstanceType": "S1L.LARGE8",
                "OsName": "Windows Server 2019",
                "ActiveTime": "00:20:20",
                "IdleTime": "00:01:00"
            }
        ],
        "Total": 1,
        "QueryKey": "d298-4c88-b7ff-0eabf528d566",
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

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	操作失败。
FailedOperation.SystemError	信令执行时发生错误,建议重试。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.UserKeyword	搜索不到用户
InvalidParameterValue	参数取值错误。

查询桌面使用时长详情

On this page: