tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

SyncImages

Last updated: 2024-10-22 19:33:20

    1. API Description

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

    This API is used to synchronize custom images to other regions.

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

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

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    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 Params. The value used for this API: SyncImages.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ImageIds.N Yes Array of String Image ID list. You can obtain the image IDs in the following ways:
  • Call the DescribeImages API and find the value of ImageId in the response.
  • Obtain the image IDs in the Image console.
    The image IDs should meet the following requirement:
  • The image ID should correspond to an image in the NORMAL state.
    • For more information on image status, see Image Data Table.
    DestinationRegions.N Yes Array of String List of target synchronization regions, which should meet the following requirements:
  • It should be a valid region.
  • If it is a custom image, the target synchronization region cannot be the source region.
  • If it is a shared image, the target synchronization region only supports the source region, meaning the shared image will be copied as a custom image in the source region.
  • Partial region synchronization is not supported currently. For details, see Copying Images.
    • For specific regional parameters, refer to Region.
    DryRun No Boolean Checks whether image synchronization can be initiated.

    Default value: false.
    ImageName No String Target image name. By default, the source image name is used.
    ImageSetRequired No Boolean Whether to return the ID of the image created in the target region.

    Default value: false.

    3. Output Parameters

    Parameter Name Type Description
    ImageSet Array of SyncImage ID of the image created in the destination region
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Synchronizing an Image

    This example shows you how to synchronize the image img-o3ycss2p to Guangzhou.

    Input Example

    POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<Common request parameters>



{
    "ImageIds": [
        "img-o3ycss2p"
    ],
    "DestinationRegions": [
        "ap-guangzhou"
    ]
}

    Output Example

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

    Example2 Synchronizing an Image to the Specified Region and Returning the New Image ID

    This example shows you how to synchronize the image img-o3ycss2p to Guangzhou.

    Input Example

    POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncImages
<Common request parameters>



{
    "ImageIds": [
        "img-o3ycss2p"
    ],
    "DestinationRegions": [
        "ap-guangzhou"
    ],
    "ImageSetRequired": true
}

    Output Example

    {
    "Response": {
        "ImageSet": [
            {
                "Region": "ap-guangzhou",
                "ImageId": "img-evhmf3fy"
            }
        ],
        "RequestId": "71e69b56-32be-4412-ab45-49eded6a87be"
    }
}

    5. Developer Resources

    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
    FailedOperation.InvalidImageState The image is busy. Please try again later.
    ImageQuotaLimitExceeded The image quota has been exceeded.
    InvalidImageId.IncorrectState Invalid image status.
    InvalidImageId.Malformed Invalid image ID format.
    InvalidImageId.NotFound The image cannot be found.
    InvalidImageId.TooLarge The image size exceeds the limit.
    InvalidImageName.Duplicate The specified image name already exists.
    InvalidParameter.InstanceImageNotSupport This API does not support instance images.
    InvalidParameterValue.InvalidImageId The image does not support this operation.
    InvalidParameterValue.InvalidImageState The image has another ongoing task. Please check and try again later.
    InvalidParameterValue.InvalidRegion The Region ID is unavailable.
    InvalidParameterValue.LimitExceeded The number of parameter values exceeds the limit.
    InvalidRegion.NotFound The region cannot be found.
    InvalidRegion.Unavailable Currently this region does not support image synchronization.
    UnsupportedOperation.EncryptedImagesNotSupported Encrypted images are not supported.
    UnsupportedOperation.LocationImageNotSupported This request does not support images in this region. Please change to another image.
    UnsupportedOperation.Region The region is unsupported.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy