Help & DocumentationAPIsCloud Virtual MachineImage APIsSyncImages

SyncImages

Last updated: 2020-03-16 18:27:30

Contents：

1. API Description

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

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

  • Each API call syncs a single image.
  • This API supports syncing an image to multiple regions.
  • Each account can have up to 10 custom images in 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 List of image IDs. You can obtain the image IDs in two ways:
  • Call DescribeImages and look for ImageId in the response.
  • Look for the information in the Image Console.
    The specified images must meet the following requirements:
  • The images must be in the NORMAL state.
  • The image size must be smaller than 50 GB.
    For more information on image states, see here.
    		•
    DestinationRegions.N Yes Array of String List of destination regions for synchronization. A destination region must meet the following requirements:
  • It cannot be the source region.
  • It must be valid.
  • Currently some regions do not support image synchronization.
    For specific regions, 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. Example

    Example1 Syncing an image

    This example shows you how to sync an image whose image ID is img-o3ycss2p to the Guangzhou region.

    Input Example

    GET 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"
  }
}

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    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
    InvalidImageId.IncorrectState Invalid image status.
    InvalidImageId.NotFound The image cannot be found.
    InvalidImageId.TooLarge The image size exceeds the limit.
    InvalidParameter.InstanceImageNotSupport This API does not support instance images.
    InvalidRegion.NotFound The region cannot be found.
    InvalidRegion.Unavailable Currently this region does not support image synchronization.