1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

This API is used to query the details of one or multiple instances.

• You can query the details of an instance according to its ID, name, or private IP.
• For more information on filters, please see Filters.
• If no parameter is defined, the status of a certain number of instances under the current account will be returned. The number is specified by Limit and is 20 by default.
• The latest operation (LatestOperation) and the latest operation status (LatestOperationState) of the instance can be queried.

A maximum of 100 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Querying the list of instances

This example shows you how to limit the number of returned results to at most one.

Input Example

https://lighthouse.intl.tencentcloudapi.com/?Action=DescribeInstances
&Limit=1
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for Node.js
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.