1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API (CreateImage) is used to create a new image from the system disk of an instance. The created image can be used to create instances.
Default interface request rate limit: 10 times per second.
Interface update time: 2022-10-28 03:48:25.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: CreateImage |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| InstanceId | No | No | String | Instance ID for Which Image Needs to be Created Example: ins-2v3sqe2t |
| ImageName | Yes | No | String | Image name Example: MyImageName |
| ImageDescription | No | No | String | Description Example: MyImageDescription |
| ForcePoweroff | No | No | String | Whether to perform forced shutdown to create an image when a soft shutdown fails. Example: true |
| Sysprep | No | No | String | Whether to enable Sysprep when creating a Windows image. Example: false |
| Reboot | No | No | String | Whether it is allowed to perform the image creation task in the shutdown state when the instance is in the running state. Example: false |
| DataDiskIds | No | No | Array of String | When creating a full machine image based on an instance, specify the data disk ID included in the image. Example: ["disk-6gabakqz"] |
| SnapshotIds | No | No | Array of String | Create an image based on a snapshot, specifying the snapshot ID should include a system disk snapshot. Should not be passed in with InstanceId at the same time. Example: ["snap-kso6f712", "snap-l3rrf322"] |
| DryRun | No | No | Bool | Detect whether this request is successful, but it will not affect the operated resources. Example: false |
| SoftPoweroff | No | No | Array of String | Whether to perform soft shutdown to make an image. Example: false |
| DedicatedClusterId | No | No | String | ID of a local dedicated cluster Example: cluster-d8htgb6k |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ImageId | String | Image ID Example: img-2v3sqe2t |
| TaskId | String | Task ID Example: 4532455 |
| flowId | Int64 | Task Flow ID Example: 2 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidInstanceId.NotFound | No corresponding instance was found. |
| ImageQuotaLimitExceeded | The image quota has exceeded the limit. |
| InvalidInstance.NotSupported | Unsupported instance. |
| InvalidImageName.Duplicate | The image name is the same as the existing image. |
| InvalidParameter.ValueTooLarge | The parameter length exceeds the limit. |
| MutexOperation.TaskRunning | The same task is already running. |