Help & DocumentationCloud Virtual Machine

SyncImages

Last updated: 2018-10-12 16:03:01

1. API Description

Domain name for API request: cvm.tencentcloudapi.com

This API (SyncImages) is used to sync a custom image to other regions.

  • Each call to this API can only sync a single image.
  • This API supports syncing to multiple regions.
  • For a single account, a maximum of 10 custom images are allowed for each region.

A maximum of 10 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: SyncImages
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ImageIds.N Yes Array of String Image ID list. Image ID can be obtained by either of the following ways:
  • From the ImageId field returned by the API DescribeImages.
  • Via the Image console.
    Image ID must meet the following requirements:
  • It must identify an image with a status of NORMAL.
  • It must identify an image smaller than 50 GB.
    For more information on image statuses, please see Image Data Sheet.
  • DestinationRegions.N Yes Array of String List of destination regions for synchronization. Destination region must meet the following requirements:
  • It cannot be the source region.
  • It must be valid.
  • Synchronization is not supported for some regions.
    For more information on region parameters, please see Region.
  • 3. Output Parameters

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

    4. Error Codes

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidImageId.IncorrectState Invalid image status.
    InvalidImageId.NotFound The image cannot be found.
    InvalidImageId.TooLarge Image size exceeds the limit.
    InvalidRegion.NotFound The region cannot be found.
    InvalidRegion.Unavailable Synchronization of images is not supported for this region.

    5. Example

    Example 1 Sync an image

    Input example

    https://cvm.tencentcloudapi.com/?Action=SyncImages
    &ImageIds.0=img-o3ycss2p
    &DestinationRegions.0=ap-guangzhou
    &<Common request parameters>

    Output example

    {
      "Response": {
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
      }
    }