Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query the details of one or multiple instances.
Limit
and is 20 by default.A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeInstances. |
Version | Yes | String | Common Params. The value used for this API: 2020-03-24. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceIds.N | No | Array of String | Instance ID list. Each request can contain up to 100 instances at a time. |
Filters.N | No | Array of Filter | Filter list. Type: String Required: No Type: String Required: No Type: String Required: No Type: String Required: No Type: String Required: No Type: String Required: No Type: String Required: No tag-key should be replaced with a specific tag key. Type: String Required: No Each request can contain up to 10 Filters and 100 Filter.Values . You cannot specify both InstanceIds and Filters at the same time. |
Offset | No | Integer | Offset. Default value: 0. For more information on Offset , please see the relevant section in Overview. |
Limit | No | Integer | Number of returned results. Default value: 20. Maximum value: 100. For more information on Limit , please see the relevant section in the API Overview. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible instances. |
InstanceSet | Array of Instance | List of instance details |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to limit the number of returned results to at most one.
https://lighthouse.tencentcloudapi.com/?Action=DescribeInstances
&Limit=1
&<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation | Operation failed. |
FailedOperation.DescribeInstanceStatus | An error occurred when querying the instance status. |
InternalError.DescribeInstanceStatus | Failed to query the instance status. Please try again later. |
InternalError.InvalidCommandNotFound | The command is not found. |
InvalidParameter.FilterValueLimitExceeded | Invalid parameter: the number of Values in the Filter parameter exceeds the allowed maximum number. |
InvalidParameter.InvalidFilter | Invalid parameter: the Filter parameter is invalid. |
InvalidParameter.InvalidFilterInvalidKey | Invalid parameter: the value of Name in the Filter parameter is invalid. |
InvalidParameter.InvalidFilterInvalidNameNotStr | Invalid parameter: the value of Name in the Filter parameter is not a string. |
InvalidParameter.InvalidFilterInvalidValuesNotList | Invalid parameter: the Values in the Filter parameter is not a list. |
InvalidParameter.InvalidFilterNotDict | Invalid parameter: the Filter parameter is not a dictionary. |
InvalidParameter.InvalidFilterNotSupportedName | Invalid parameter: there are unsupported Name values in the Filter parameter. |
InvalidParameter.ParameterConflict | Invalid parameter: the parameters conflict. |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.InstanceNameTooLong | Invalid parameter value: the length of the instance name exceeds the upper limit. |
InvalidParameterValue.InvalidIpFormat | Invalid parametric value: the IP address format is invalid. |
InvalidParameterValue.InvalidZone | Invalid Zone value. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
InvalidParameterValue.Negative | Invalid parametric value: it cannot be negative. |
InvalidParameterValue.OutOfRange | Invalid parametric value: it is not within the valid range. |
ResourceNotFound.InstanceIdNotFound | The instance ID does not exist. |
UnauthorizedOperation.NoPermission | No permission |
UnauthorizedOperation.TokenInvalid |
Was this page helpful?