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.
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. |
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. |
This example shows you how to create an image.
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"
}
{
"Response": {
"BlueprintId": "lhbp-xkeh87da",
"RequestId": "6bdba9db-c3fe-45b2-87f3-b0125d901a90"
}
}
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.CreateBlueprintFailed | Failed to create the image. |
FailedOperation.InsufficientBalance | |
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. |
LimitExceeded.BlueprintQuotaLimitExceeded | Failed to create the custom image: Reached the upper limit of custom image quota. |
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. |
Was this page helpful?