全部产品
Search
文档中心

云服务器 ECS:ModifyImageSharePermission - 管理镜像共享权限

更新时间:Jul 09, 2024

调用ModifyImageSharePermission管理镜像共享权限。您可以将自己的自定义镜像共享给其他阿里云账号,也可以发布为社区镜像供他人使用。

接口说明

调用该接口时,您需要注意:

  • 您只能共享自己的自定义镜像给其他阿里云用户。
  • 每份自定义镜像一次最多共享给 10 个阿里云账号。所以,参数 AddAccount.n 或者参数 RemoveAccount.n 单次最多可以传入 10 个阿里云账号,若一次提交超过 10 个阿里云账号,系统将只处理前 10 个,忽略多余的账号。
  • 每份自定义镜像最多可以共享给 50 个阿里云账号。
  • 使用共享镜像创建 ECS 实例( RunInstances )后,一旦自定义镜像拥有者解除了镜像共享关系,或者删除了自定义镜像( DeleteImage ),该实例将无法初始化系统盘( ReInitDisk )。

发布或下架社区镜像,您需要注意:

  • 社区镜像的所有者需要为对应的社区镜像的质量与迭代负责,阿里云仅提供平台支撑。请确保您已知晓社区镜像协议内容,并已签订协议,否则不允许发布社区镜像。更多信息,请参见发布社区镜像
  • 加密镜像不允许发布为社区镜像。
  • 社区镜像完全公开,在镜像所属地域下,所有阿里云账号均可使用。
  • 社区镜像不支持共享、导出与复制。
  • 已发布的社区镜像一旦下架,将不再对其他所有的阿里云账号公开。如果该自定义镜像已共享至其它阿里云账号,共享关系会继续保持。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:ModifyImageSharePermissionWRITE
  • Image
    acs:ecs:{#regionId}:{#accountId}:image/{#imageId}

请求参数

名称类型必填描述示例值
RegionIdstring

自定义镜像所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ImageIdstring

被共享的自定义镜像 ID。

m-bp18ygjuqnwhechc****
LaunchPermissionstring
说明 该参数正在邀测中,暂不支持使用。
hide
AddAccountarray

授权共享镜像的阿里云账号 ID。N 的取值范围:1~10,若一次提交超过 10 个阿里云账号,系统将只处理前 10 个,忽略多余的账号。

string

授权共享镜像的阿里云账号 ID。N 的取值范围:1~10,若一次提交超过 10 个阿里云账号,系统将只处理前 10 个,忽略多余的账号。

1234567890
RemoveAccountarray

删除镜像共享的阿里云账号 ID。N 的取值范围:1~10,若一次提交超过 10 个阿里云账号,系统将只处理前 10 个,忽略多余的账号。

string

删除镜像共享的阿里云账号 ID。n 的取值范围:1~10,若一次提交超过 10 个阿里云账号,系统将只处理前 10 个,忽略多余的账号。

1234567890
IsPublicboolean

是否发布或下架社区镜像。取值范围:

  • true:发布该镜像为社区镜像。
  • false:下架该镜像为普通镜像,若该镜像本身是普通镜像,则不做改变。

默认值:false。

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter "RegionId" that is mandatory for processing this request is not supplied.-
400InvalidGroup.MalformedThe specified Group is wrongly formed.指定的组不存在。
400UnnecessaryParameter.LaunchPermissionThe specified parameter "LaunchPermission" is unnecessary if paramter "AddAccounts" or "RemoveAccounts" exist.-
400InvalidParameter.LaunchPermissionThe specified parameter "LaunchPermission" is invalid.-
400ForbiddenParameter.LaunchPermissionThe specified parameter "LaunchPermission" is forbidden for current account.-
403AssumeRoleErrorRequires a RAM role of AliyunECSShareEncryptImageDefaultRole before sharing encrypted image.您在共享加密镜像前需要添加 AliyunECSShareEncryptImageDefaultRole RAM 角色。
403ImageDescription.ContainsSensitiveWordsThe specified image description contains sensitive words.指定的镜像描述包含敏感词汇。
403ImageName.ContainsSensitiveWordsThe specified image name contains sensitive words.指定的镜像名称包含敏感词汇。
403Image.PublicThe specified image is public image.-
403CurrentRegion.NotSupportPublicImagePublic image is not supported for current region.-
403Image.NotPublicThe specified image is not public image.您指定的镜像不是公共权限,不能修改为私有权限。
403OperationDeined.FullImageThe encrypted image contains multiple snapshots, which do not support share.-
403QuotaExceed.ShareImageThe shared Image Quota exceeds.已经超过自定义镜像共享配额限制。
403QuotaExceed.ShareImageUserThe shared Image user Quota exceeds.已经超过单个镜像共享给用户数量的配额限制。
403InvalidImageId.BidMismatchCannot share image with other bid user.镜像无法跨运营商共享。
403OperationDeined.EncryptedSnapshotThe image contains encrypted snapshots, which do not support share.指定的镜像含有加密快照,不支持共享这种镜像。
403OperationDenied.InvalidImageStatusThe specified image cannot be shared when it is deprecated.不能共享已经被弃用的镜像。
403PublicImageAgreement.NotSignedThe current account has not signed "Community Image Terms of Service".当前账户没有签署社区镜像协议。
403InvalidParameter.IsPublicThe specified parameter IsPublic is conflicted with other parameters.指定的参数IsPublic与其他参数冲突。
404InvalidImageId.NotFoundThe specified ImageId does not exist.指定的镜像在该用户账号下不存在,请您检查镜像 ID 是否正确。
404InvalidAccount.NotFoundThe specified parameter "AddAccount.n" or "RemoveAccount.n" does not exist.-
404InvalidAccount.ForbbidenThe specified Account does not yourself.不能把镜像共享给自己。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-11OpenAPI 错误码发生变更查看变更详情
2023-04-19OpenAPI 错误码发生变更查看变更详情
2023-04-10OpenAPI 错误码发生变更查看变更详情
2021-06-23OpenAPI 错误码发生变更查看变更详情