查看实例列表

1. 接口描述

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

本接口（DescribeInstances）用于查询一个或多个实例的详细信息。

• 可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。
• 过滤信息详细请见过滤器 Filters 。
• 如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。
• 支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationState）。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查看实例列表

限制返回结果最多为一项

输入示例

https://lighthouse.tencentcloudapi.com/?Action=DescribeInstances
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "InstanceSet": [
            {
                "InstanceId": "lhins-ruy9d2tw",
                "BundleId": "bundle_bw_small1_1",
                "BlueprintId": "lhbp-5e8807lo",
                "Zone": "ap-guangzhou-3",
                "CPU": 1,
                "Memory": 1,
                "InstanceName": "lighthouse-test",
                "OsName": "CentOS 7.6 64bit",
                "Platform": "CENTOS",
                "PlatformType": "LINUX_UNIX",
                "InstanceChargeType": "PREPAID",
                "SystemDisk": {
                    "DiskType": "CLOUD_PREMIUM",
                    "DiskSize": 50,
                    "DiskId": "lhdisk-gayq6kyd"
                },
                "PrivateAddresses": [
                    "10.0.0.5"
                ],
                "PublicAddresses": [
                    "170.106.15.201"
                ],
                "InternetAccessible": {
                    "InternetChargeType": "TRAFFIC_POSTPAID_BY_HOUR",
                    "InternetMaxBandwidthOut": 20,
                    "PublicIpAssigned": true
                },
                "RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
                "LoginSettings": {
                    "KeyIds": []
                },
                "Tags": [
                    {
                        "Key": "lighthouse",
                        "Value": "great"
                    }
                ],
                "InstanceState": "RUNNING",
                "InstanceRestrictState": "NORMAL",
                "Uuid": "1322d32a-2641-45f3-a244-559405b32228",
                "LatestOperation": "StartInstances",
                "LatestOperationState": "SUCCESS",
                "LatestOperationRequestId": "6b9a6dac-888a-4b4d-9739-0d0b66cbfa88",
                "CreatedTime": "2020-04-28T03:46:09Z",
                "ExpiredTime": "2020-05-28T03:46:09Z",
                "IsolatedTime": null
            }
        ],
        "RequestId": "c9aa9e9b-bb2b-4390-b8da-fc976ffc4608"
    }
}

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: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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