Domain name for API request: lighthouse.tencentcloudapi.com.
This API is used to query the information of an image instance.
A maximum of 10 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: DescribeBlueprintInstances. |
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 | Yes | Array of String | Instance ID list, which currently can contain only one instance. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible image instances. |
BlueprintInstanceSet | Array of BlueprintInstance | Image instance list information. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://lighthouse.tencentcloudapi.com/?Action=DescribeBlueprintInstances
&InstanceIds.0=lhins-f4s49nap
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"BlueprintInstanceSet": [
{
"InstanceId": "lhins-aaaabbbb",
"Blueprint": {
"BlueprintId": "lhbp-5e8807sc",
"DisplayTitle": "wordpress",
"DisplayVersion": "5.3.2",
"Description": "Personal blog website construction",
"OsName": "CentOS-7.6-64bit",
"Platform": "CENTOS",
"PlatformType": "LINUX_UNIX",
"BlueprintName": "my-blueprint",
"BlueprintType": "APP_OS",
"ImageUrl": "http://www.wordpress.com/image",
"RequiredMemorySize": 2,
"RequiredSystemDiskSize": 10,
"BlueprintState": "NORMAL",
"SupportAutomationTools": true,
"CreatedTime": "2020-09-22T00:00:00+00:00",
"ImageId": "img-f82x5lxe"
},
"SoftwareSet": [
{
"Name": "wordpress",
"Version": "5.3.2",
"ImageUrl": "",
"InstallDir": "/usr/local/lighthouse/softwares/wordpress",
"DetailSet": [
{
"Key": "IndexUrl",
"Title": "Homepage address",
"Value": "http://xxx.xxx.xxx.xxx"
}
]
}
]
}
],
"RequestId": "989f74ea-567c-4c99-a24e-7bc200cf679b"
}
}
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. |
InternalError | Internal error. |
InternalError.InvalidCommandNotFound | The command is not found. |
InvalidParameterValue | Incorrect parameter value. |
InvalidParameterValue.Duplicated | Invalid parameter value: duplicate values are not allowed. |
InvalidParameterValue.InstanceIdMalformed | Invalid parameter value: the instance ID format is invalid. |
InvalidParameterValue.LimitExceeded | Invalid parametric value: the number of parameter values exceeds the upper limit. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource does not exist. |
UnauthorizedOperation.NoPermission | No permission |
Was this page helpful?