tencent cloud



Last updated: 2023-08-18 14:28:11

1. API Description

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

This API is used to create an image with the system disk of an instance. The image can be used to create instances.

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: CreateImage.
Version Yes String Common Params. The value used for this API: 2019-07-19.
Region No String Common Params. This parameter is not required for this API.
ImageName Yes String Image name.
InstanceId Yes String ID of the instance for which to make an image.
ImageDescription No String Image description.
ForcePoweroff No String Whether to perform a forced shutdown to make an image. Valid values:
TRUE: yes
Default value: FALSE.

3. Output Parameters

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

4. Example

Example1 Creating image

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TaskId": "1528611",
        "RequestId": "a3c3e99e-c4d7-11ea-ba2d-52540002f896"

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.InstanceNotAllStopped Not all instances are shut down.
FailedOperation.InternalOperationFailure Internal error.
InvalidParameter The parameter is incorrect.
InvalidParameter.InvalidDataFormat The data format is incorrect.
InvalidParameterValue.ImageNameDuplicate The image name is duplicate.
InvalidParameterValue.InvalidInstanceID The instance ID is invalid.
MissingParameter The parameter is missing.
MissingParameter.MissingImageParameter The image operation parameters are incomplete.
ResourceInsufficient.InvaildPrivateImageNum The number of private images exceeds the limit.
UnauthorizedOperation.ForbiddenOperation You don't have the permission to perform this operation.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.InstanceIdNotFound The instance ID is invalid, as the specified instance ID does not exist.
UnsupportedOperation.InstanceIdNotSupported The instance is not supported.
UnsupportedOperation.InvalidInstanceState This operation cannot be performed in the current status.
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