tencent cloud

All product documents
Tencent Cloud Lighthouse
DocumentationTencent Cloud LighthouseAPI DocumentationImage APIsDescribeBlueprintInstances
DescribeBlueprintInstances
Download PDF
Last updated: 2023-12-04 16:31:59
DescribeBlueprintInstances
Last updated: 2023-12-04 16:31:59
Download PDF

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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.

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.

3. Output Parameters

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.

4. Example

Example1 Querying image instance information

Input Example

https://lighthouse.tencentcloudapi.com/?Action=DescribeBlueprintInstances
&InstanceIds.0=lhins-f4s49nap
&<Common request parameters>

Output Example

{
    "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"
    }
}

5. Developer Resources

SDK

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

Command Line Interface

6. Error Code

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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon