ModifyShareImage - 共享或取消共享镜像

更新时间:
复制 MD 格式

将镜像共享给无影的其他用户或者取消已经共享的镜像。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:ModifyShareImage

update

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ImageId

string

否

源镜像 id

img-bp13mu****

AddAccount

array

否

添加共享的 aliuid

integer

否

接受镜像共享的阿里云账号 ID。可共享给 1~50 个阿里云账号。

110014**********

RemoveAccount

array

否

删除共享的 aliuid

integer

否

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

181080*******

BizType

integer

否

业务线,当前只支持企业版场景,默认值 1。

枚举值:

  • 1 :

    企业版

  • 10 :

    个人版

1

ProductType

string

否

产品类型 :云桌面,云应用,工作站等。

枚举值:

  • CloudDesktop :

    云桌面

  • CloudApp :

    云应用

  • WuyingServer :

    无影工作站

CloudDesktop

返回参数

名称

类型

描述

示例值

object

PlainResult

Data

boolean

返回结果。

枚举值:

  • true :

    成功

  • false :

    失败

true

Success

boolean

是否成功。

true

Code

string

错误码。

200

Message

string

出错时的错误消息。

null

RequestId

string

请求 ID

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

{
  "Data": true,
  "Success": true,
  "Code": "200",
  "Message": "null",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InternalError Internal error. 内部错误
400 InvalidBaseImage.NotFound Base image not found. 基础镜像找不到。
400 InvalidSourceImage.StatusNotAvailable Invalid source image status. 源镜像状态非正常。
400 InvalidSourceImage.ImageTypeCannotBeShared Source image cannot be shared. 源镜像类型不支持共享。
400 BizTypeNotMatch The bizType and image do not match. 输入BizType和镜像不匹配。
400 ProductTypeNotMatch The productType and image do not match. 输入ProductType和镜像不匹配。
400 ExceedAddAccountQuota The maximum number of account addition is reached. 添加账号达到上限。
400 InvalidTargetAliUid.TargetShareImageAlreadyExist Target shared image already exists. 共享镜像已经存在。
400 InvalidParameter.ImageId The image ID is invalid. 镜像ID不合法。
400 InvalidBizType The bizType parameter is invalid. 业务类型不合法。
400 InvalidParameter.AddAccount/RemoveAccount The tenant ID to be added or removed is invalid. 添加或删除共享的租户ID不合法。

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

变更历史

更多信息,参考变更详情。