tencent cloud



Last updated: 2023-05-22 15:38:54

1. API Description

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

This API is used to create an image.

A maximum of 20 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: CreateBlueprint.
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.
BlueprintName Yes String Image name, which can contain up to 60 characters.
Description No String Image description, which can contain up to 60 characters.
InstanceId No String ID of the instance for which to make an image.
ForcePowerOff No Boolean Whether to forcibly shut down the instance before creating the image
Valid values:
True: Shut down and instance first
False: Create the image when the instance is running
Default: True
Note that if you create an image when the instance is running, there might be data loss.

3. Output Parameters

Parameter Name Type Description
BlueprintId String Custom image ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating an image of a Lighthouse instance

This example shows you how to create an image.

Input Example

POST / HTTP/1.1 
Host: lighthouse.tencentcloudapi.com 
Content-Type: application/json 
X-TC-Action: CreateBlueprint 
<Common request parameters>

    "BlueprintName": "test-blueprint",
    "InstanceId": "lhins-7ugtz5e1"

Output Example

    "Response": {
        "BlueprintId": "lhbp-xkeh87da",
        "RequestId": "6bdba9db-c3fe-45b2-87f3-b0125d901a90"

5. Developer Resources


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.CreateBlueprintFailed Failed to create the image.
FailedOperation.UnableToCreateBlueprint The operation failed. The custom image could not be created.
InternalError Internal error.
InternalError.DescribeInstanceStatus Failed to query the instance status. Please try again later.
InvalidParameterValue.InstanceIdMalformed Invalid parameter value: the instance ID format is invalid.
InvalidParameterValue.TooLong The length of the parameter value exceeds the upper limit.
ResourceNotFound.InstanceIdNotFound The instance ID does not exist.
UnauthorizedOperation.NoPermission No permission
UnsupportedOperation.InvalidInstanceState Unsupported operation: the instance status is invalid.
UnsupportedOperation.LatestOperationUnfinished Unsupported operation: the last operation of the instance has not been completed.
Contact Us

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

Technical Support

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

7x24 Phone Support