1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口 (SyncBlueprint) 用于将自定义镜像同步到其它地域。
- 支持向多个地域同步。最多10个地域。
- 不支持向源地域同步。
- 只支持NORMAL状态的镜像进行同步。
- 不支持中国大陆地域和非中国大陆地域之间同步。
- 可以通过DescribeBlueprints查询镜像状态,当镜像状态为NORMAL时表示源地域同步结束。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SyncBlueprint。 |
| Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| BlueprintId | 是 | String | 镜像ID。 示例值:lhbp-sdeji832 |
| DestinationRegions.N | 是 | Array of String | 同步镜像的目的地域列表。 示例值:["ap-beijing","ap-shanghai"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DestinationRegionBlueprintSet | Array of DestinationRegionBlueprint | 目标地域镜像信息。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 跨地域同步自定义镜像
向两个地域同步自定义镜像。
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncBlueprint
<公共请求参数>
{
"BlueprintId": "lhbp-ls883feh",
"DestinationRegions": [
"ap-singapore",
"ap-hongkong"
]
}
输出示例
{
"Response": {
"DestinationRegionBlueprintSet": [
{
"Region": "ap-singapore",
"BlueprintId": "lhbp-lf3gjs2f"
},
{
"Region": "ap-hongkong",
"BlueprintId": "lhbp-lfle246l"
}
],
"RequestId": "e35a5b7b-4dfa-49f8-8729-ba5c504807e0"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.BalanceInsufficient | 账户余额不足。 |
| FailedOperation.DescribeBlueprintQuotaFailed | 查询镜像配额失败。 |
| FailedOperation.NumLimitError | 购买数量超过最大限制。 |
| FailedOperation.RequestError | 请求错误。 |
| FailedOperation.UnableToSyncBlueprint | 当前镜像状态无法进行跨地域同步。 |
| InternalError | 内部错误。 |
| InvalidParameterValue.BlueprintIdMalformed | 参数值非法,镜像 ID 格式非法。 |
| InvalidParameterValue.DestinationRegionSameAsSourceRegion | 目的地域与源地域相同。 |
| InvalidParameterValue.Duplicated | 参数值非法,不允许包含重复的值。 |
| InvalidParameterValue.NotSupportCrossBorderSyncBlueprint | 不支持跨境同步镜像。 |
| InvalidParameterValue.UnavailableRegion | 地域不可用。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.SyncBlueprintQuotaLimitExceeded | 超过同步镜像目的地域镜像配额。 |
| OperationDenied.BlueprintOperationInProgress | 镜像在操作中。请稍后再试。 |
| ResourceNotFound.PrivateBlueprintNotFound | 自定义镜像不存在。 |
| UnauthorizedOperation.CertificationNeedUpgrade | 因账号安全升级,购买云资源需完善您的实名信息。 |
| UnauthorizedOperation.NoPermission | 无权限。 |
| UnauthorizedOperation.NotCertification | 账号没有实名认证,支付失败。 |
| UnsupportedOperation.BlueprintCurStateInvalid | 镜像当前状态不支持该操作。 |
| UnsupportedOperation.BlueprintLatestOperationUnfinished | 镜像最近一次的操作尚未完成。 |