ImportSnapshot

Last Updated At: 2026-08-02 00:05:21

1. Interface Description

Interface request domain name: cvm.api3.convergecloud.com.

Import a data disk image and make it as a CBS snapshot. The snapshot can be used to create a CBS data disk.

Default interface request rate limit: 20 times per second.

Interface update time: 2018-03-07 02:38:54.

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: ImportSnapshot
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
SnapshotName Yes No String Name of Created Snapshot
Example: FirstSnapshot
SnapshotDescription No No String Description of Created Snapshot
Example: jack use
SnapshotUrl Yes No String COS Link of Data Disk Image
Example: http://111-1251243127.cosd.convergecloud.com/Windows%20Server%202008%20R2%20x64a.vmdk
SnapshotSize Yes No Int64 Size of Created Snapshot
Example: 50
DryRun No No Bool True is for checking parameters only, false by default.
Example: true

3. Output Parameters

Parameter name Type Description
TaskId String Task ID, can be used to query the task status.
Example: 432322
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

There is no error code related to business logic for this interface, For other error codes, see public ErrorCode.