1. 接口描述

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

获取云桌面实例详细信息

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 DescribeInstances

输入示例

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

{
    "PageNumber": 1,
    "Filters": [
        {
            "Values": [
                "Region"
            ],
            "Name": "ap-shanghai"
        }
    ],
    "PageSize": 20
}

输出示例

{
    "Response": {
        "InstanceList": [
            {
                "InstanceId": "cdi-0s9hw",
                "Name": "0s9hw",
                "Status": "STOPPED",
                "UserName": "xxa",
                "UserId": "xxa",
                "InstanceType": "S1LARGE8",
                "SysDisk": {
                    "DiskType": "CLOUD_SSD",
                    "DiskSize": 0,
                    "DiskId": "disk1"
                },
                "DataDiskList": [
                    {
                        "DiskType": "CLOUD_SSD",
                        "DiskSize": 0,
                        "DiskId": "disk2"
                    }
                ],
                "Region": "ap-shanghai",
                "ChargeType": "POSTPAID_BY_HOUR",
                "AutoRenewFlag": "NOTIFY_AND_MANUAL_RENEW",
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "ExpiredTime": "2020-09-22T00:00:00+00:00",
                "Description": "",
                "HostName": "0s9hw",
                "DisplayName": "0s9hw",
                "BindStatus": "UNBOUND",
                "ImageId": "image-1",
                "UserVpcId": "vpc-1",
                "UserSubnetId": "subnet-1",
                "UserPrivateIp": "0.0.0.0",
                "IsolatedTime": "2020-09-22T00:00:00+00:00",
                "LastStatusChangeReason": "",
                "LatestOperation": "",
                "LatestOperationState": "",
                "LatestOperationRequestID": "",
                "OsName": "Windows Server",
                "SetId": "",
                "AppId": 0,
                "Uin": "1******43",
                "SecurityGroups": [
                    "sg1"
                ]
            }
        ],
        "Total": 0,
        "RequestId": "abc-avc"
    }
}

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. 错误码

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