DeleteImage - 删除自定义镜像

更新时间:
复制 MD 格式

删除一个自定义的无影镜像

接口说明

  • 只能删除用户所属的自定义镜像。

  • 针对产品线是无影云电脑池,无影云应用,无影工作站的镜像,确保没有无影实例使用该镜像,才能正常删除。

  • 无影云桌面模板引用镜像,在删除镜像的时候会将模板也一起删除。

  • 针对镜像包含多个地域的,删除镜像时所有地域的镜像都会删除。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:DeleteImage

delete

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ImageId

string

否

无影镜像 ID。

img-bp13mu****

返回参数

名称

类型

描述

示例值

object

请求返回结构体。

Code

string

状态码:

  • 200:成功。

  • 400:出错。

200

Data

boolean

删除是否成功。

枚举值:

  • true :

    删除成功

  • false :

    删除失败

true

Message

string

出错时的错误消息。

successful

RequestId

string

请求 ID。

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

Success

boolean

是否成功。

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 InternalError Internal error. 内部错误
400 Image.NotExist The image does not exist. 镜像不存在。
400 ImageDeleteFailed.NotAllow The image is not allowed to be deleted. 镜像不允许删除。
400 ImageDeleteFailed.NotAllowCommunityParent The parent image of a community image is not allowed to be deleted. 社区镜像父镜像不允许删除。
400 ImageDeleteFailed.NotAllowSharedImage The shared image is not allowed to be deleted. 共享镜像不允许删除。
400 ImageNotAllowDelete The image cannot be deleted, because shared cloud computers already exist. 镜像不能删除,已经存在共享型云电脑资源。
400 InvalidImageOperation.ImageIsCreating Failed to operation the image, it is creating. 镜像在创建中,操作无效。
400 DeleteTemplate.Failed Delete template failed. 删除模板失败。
400 QueryTemplate.Failed Query template failed. 查找模板失败。
400 InvalidTemplate.NotFound Template not found. 模版未找到。
400 ImageDeleteFailed.HasSharedImage The shared image is not allowed to be deleted. 共享镜像不允许删除。
500 ServiceUnavailable Service unavailable. Please try again later. 服务不可用,请稍后再试。

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

变更历史

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