Tenant Cloud Compute Cloud Virtual Machine Image APIs SyncImages

SyncImages

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

1. Interface Description

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

This API (SyncImages) is used to synchronize custom images to other regions.

  • This API supports synchronizing only one image per call.
  • This API supports multiple synchronization regions.
  • A single account can have a maximum of 10 custom images in each region.

Default interface request rate limit: 10 times per second.

Interface update time: 2018-04-04 09:23:06.

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: SyncImages
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
ImageIds Yes No Array of String List of image IDs. You can obtain the image ID in the following ways:
  • Through the ImageId returned by the API DescribeImages.
  • Through the DescribeImages.
    The image ID should meet the following restrictions:
  • The image status corresponding to the image ID should be NORMAL.
  • The image size is less than 50 GB.
    For image statuses, see the Image Data Table.
    Example: ["img-o3ycss2p"]
    		•
    DestinationRegions Yes No Array of String List of destination synchronization regions; it must meet the following restrictions:
  • Should not be the source region,
  • Must be a valid Region.
  • Partial region synchronization is not supported at this time.
    For specific region parameters, see Region.
    Example: ["ap-region1"]
    		•

    3. Output Parameters

    Parameter name Type Description
    ImageSet Array of ImageSet Image collection.
    Example:View
    TaskId String Task ID
    Example: task-6a79x94v
    flowId String Process ID
    Example: 1
    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
    InvalidImageId.IncorrectState The image status is illegal.
    InvalidImageId.NotFound Image not found
    InvalidImageId.TooLarge The image size exceeds the limit.
    InvalidRegion.NotFound The specified zone was not found.
    InvalidRegion.Unavailable Currently, this zone does not support synchronizing an image.
    InvalidParameterValue.InvalidImageId The image ID is invalid.
    InvalidImageName.Duplicate The image name is the same as the existing image.