1. 接口描述
接口请求域名： lighthouse.tencentcloudapi.com 。
本接口 (ModifyImageSharePermission) 用于共享和取消共享CVM自定义镜像到轻量应用服务器服务。
CVM镜像共享到轻量应用服务器镜像需要满足如下条件：
1.已共享过的镜像不支持再次共享。
2.外部导入的镜像不支持共享。
3.整机镜像不支持共享。
4.镜像要支持Cloudinit才支持共享。
5.镜像的Platform和OsName要满足。
6.NORMAL状态的镜像才支持共享。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyImageSharePermission。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ImageId | 是 | String | 镜像 ID。可通过DescribeImages接口返回值中的ImageId获取。 示例值：img-dw8adx |
| Permission | 是 | String | 共享属性，包括 SHARE，CANCEL。其中SHARE代表共享，CANCEL代表取消共享。 示例值：SHARE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BlueprintId | String | CVM自定义镜像共享到轻量应用服务器后的镜像ID。 注意：此字段可能返回 null，表示取不到有效值。 示例值：lhbp-xkeh87da |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 共享CVM镜像到轻量应用服务器镜像
共享CVM镜像到轻量应用服务器镜像。
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSharePermission
<公共请求参数>
{
"ImageId": "img-xkd784jw",
"Permission": "SHARE"
}输出示例
{
"Response": {
"BlueprintId": "lhbp-su83x02a",
"RequestId": "4fe640d6-4912-4b43-9b3a-cc3bbab4cef2"
}
}示例2 CVM镜像取消共享到轻量应用服务器镜像
CVM镜像取消共享到轻量应用服务器镜像
输入示例
POST / HTTP/1.1
Host: lighthouse.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSharePermission
<公共请求参数>
{
"ImageId": "img-xkd784jw",
"Permission": "CANEL"
}输出示例
{
"Response": {
"BlueprintId": null,
"RequestId": "4fe640d6-4912-4b43-9b3a-cc3bbab4cef2"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ImageOperationFailed | 操作镜像失败。 |
| FailedOperation.RequestError | 请求错误。 |
| InternalError.RequestError | 请求出现错误。 |
| InvalidParameterValue.InvalidImageIdMalformed | 镜像ID格式非法。 |
| ResourceInUse.ImageInUse | 镜像在使用中，不支持此操作。 |
| ResourceNotFound.ImageIdNotFound | 镜像ID不存在。 |
| ResourceNotFound.RoleNotFound | 服务角色不存在, 请为账号添加这个角色。 |
| UnauthorizedOperation.NoPermission | 无权限。 |
| UnsupportedOperation.AssumeRoleFailed | 获取角色授权失败，请授予 Lighthouse 相关角色后进行重试。 |
| UnsupportedOperation.ImageAlreadyShared | 镜像已经被共享。不支持此操作。 |
| UnsupportedOperation.ImageOccupied | 镜像整在被资源进行操作，镜像被占用，不支持此操作。请稍后再试。 |
| UnsupportedOperation.ImageUnableToShare | 镜像不支持共享。 |
