1. 接口描述
接口请求域名: lighthouse.tencentcloudapi.com 。
本接口(ShareBlueprintAcrossAccounts)用于跨账号共享镜像。
仅支持共享自定义镜像, 且用于共享的镜像状态必须为NORMAL。
共享的账号必须为主账号。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ShareBlueprintAcrossAccounts。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-24。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BlueprintId | 是 | String | 镜像ID, 可以通过DescribeBlueprints接口返回的BlueprintId获取。 示例值:lhbp-6jc6l8yb |
AccountIds.N | 是 | Array of String | 接收共享镜像的账号Id列表。账号ID不同于QQ号,查询用户账号ID请查看账号信息中的账号ID栏。账号个数取值最大为10。 示例值:["700000164995"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 跨账号共享镜像
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ShareBlueprintAcrossAccounts
<公共请求参数>
{
"BlueprintId": "lhbp-6jc6l8yb",
"AccountIds": [
"700000164995"
]
}
输出示例
{
"Response": {
"RequestId": "d339efa9-f637-4ba9-a7c6-fb89ce67d76f"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ShareBlueprintAcrossAccountFailed | 跨账号共享镜像失败,请稍后重试。 |
InvalidParameterValue.AccountIdInvalidAccountArea | 镜像不允许共享至不同站点的账号。 |
InvalidParameterValue.AccountIdSameWithUin | 账号为当前用户。 |
InvalidParameterValue.AccountIdsNotExist | 账号ID不存在。 |
InvalidParameterValue.AccountIdsNotOwnerAccount | 账号ID不为主账号。 |
InvalidParameterValue.BlueprintIdMalformed | 参数值非法,镜像 ID 格式非法。 |
InvalidParameterValue.InvalidBlueprintId | 镜像 ID 不合法。 |
InvalidParameterValue.InvalidBlueprintState | 镜像状态取值非法。 |
LimitExceeded.ShareBlueprintAcrossAccountQuotaLimitExceeded | 镜像当前配额不足,无法共享至指定账号。 |
OperationDenied.BlueprintOperationInProgress | 镜像在操作中。请稍后再试。 |
ResourceInUse.BlueprintModifyingSharePermission | 镜像正在修改共享属性操作中。不支持此操作。 |
ResourceNotFound.BlueprintIdNotFound | 镜像 ID 不存在。 |
ResourceNotFound.PrivateBlueprintNotFound | 自定义镜像不存在。 |
UnauthorizedOperation.NoPermission | 无权限。 |
UnauthorizedOperation.TokenInvalid | 无权限进行此操作,请求中token不合法。 |
UnsupportedOperation.BlueprintAlreadyShared | 镜像已经被共享。不支持此操作。 |
UnsupportedOperation.BlueprintCurStateInvalid | 镜像当前状态不支持该操作。 |
UnsupportedOperation.BlueprintLatestOperationUnfinished | 镜像最近一次的操作尚未完成。 |
UnsupportedOperation.BlueprintOccupied | 镜像被使用中,不支持该操作。 |