SyncBlueprint

Last updated:2026-01-13 21:47:51

SyncBlueprint

Last updated: 2026-01-13 21:47:51

1. API Description

Domain name for API request: lighthouse.intl.tencentcloudapi.com.

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

Synchronization to multiple regions is supported. Up to 10 regions are supported.
Synchronization to the source region is not supported.
Only images in the NORMAL status are supported for synchronization.
Synchronization between Chinese mainland regions and regions outside the Chinese mainland is not supported.
- You can use the DescribeBlueprints API to query the image status. When the status is NORMAL, it indicates that the source region synchronization ends.

A maximum of 20 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: SyncBlueprint.
Version	Yes	String	Common Params. The value used for this API: 2020-03-24.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
BlueprintId	Yes	String	Image ID.
DestinationRegions.N	Yes	Array of String	List of target regions for image synchronization.

3. Output Parameters

Parameter Name	Type	Description
DestinationRegionBlueprintSet	Array of DestinationRegionBlueprint	Image information of the target 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 Cross-Region Synchronization of Custom Images

This example shows you how to synchronize a custom image to two regions.

Input Example

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

{
    "BlueprintId": "lhbp-ls883feh",
    "DestinationRegions": [
        "ap-singapore",
        "ap-hongkong"
    ]
}

Output Example

{
    "Response": {
        "DestinationRegionBlueprintSet": [
            {
                "Region": "ap-singapore",
                "BlueprintId": "lhbp-lf3gjs2f"
            },
            {
                "Region": "ap-hongkong",
                "BlueprintId": "lhbp-lfle246l"
            }
        ],
        "RequestId": "e35a5b7b-4dfa-49f8-8729-ba5c504807e0"
    }
}

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

Tencent Cloud CLI 3.0

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
AuthFailure	Error with CAM signature/authentication.
FailedOperation.BalanceInsufficient	The account balance is insufficient.
FailedOperation.DescribeBlueprintQuotaFailed	Failed to query the image quota.
FailedOperation.NumLimitError	The upper limit of the purchase quantity is exceeded.
FailedOperation.RequestError	A request error occurred.
FailedOperation.UnableToSyncBlueprint	The current image status does not allow cross-region synchronization.
InternalError	Internal error.
InvalidParameterValue.BlueprintIdMalformed	Invalid parameter value: the image ID format is invalid.
InvalidParameterValue.DestinationRegionSameAsSourceRegion	The target region is the same as the source region.
InvalidParameterValue.Duplicated	Invalid parameter value: duplicate values are not allowed.
InvalidParameterValue.NotSupportCrossBorderSyncBlueprint	Cross-border image synchronization is not supported.
InvalidParameterValue.UnavailableRegion	The region is not available.
LimitExceeded	Reached the quota limit.
LimitExceeded.SyncBlueprintQuotaLimitExceeded	The image quota limit for the target region is exceeded.
OperationDenied.BlueprintOperationInProgress	The image is being operated on. Try again later.
ResourceNotFound.PrivateBlueprintNotFound	The custom image does not exist.
UnauthorizedOperation.CertificationNeedUpgrade	Completing identity information is required for cloud resource purchases due to account security upgrades.
UnauthorizedOperation.NoPermission	No permission.
UnauthorizedOperation.NotCertification	The payment failed because the account identity verification has not been completed.
UnsupportedOperation.BlueprintCurStateInvalid	The current status of the image does not support this operation.
UnsupportedOperation.BlueprintLatestOperationUnfinished	The last operation on the image is not completed yet.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud