ModifyImagesAttributes

1. 接口描述

本接口（ModifyImageAttributes）用于修改镜像属性。

注意事项

• 目前支持修改自定义镜像的属性有：

  • 镜像名称。

  • 镜像描述。

• 如果传入多个镜像ID，仅支持所有镜像修改为同一属性。

• 只可修改自定义镜像的属性。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
imageIds	是	Array of String	镜像ID。 可从DescribeImages返回的imageId获取。
imageName	否	String	新的镜像名称。 镜像名称必须符合以下规则： 长度不超过24位 支持中文、字母、数字或连接符号 -_.
imageDescription	否	String	新的镜像描述。 描述信息不得超过255个字符。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

示例

1. 修改镜像属性。

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: ModifyImagesAttributes
<Common Request Params>

Request:
{
  "imageIds": [
    "img-xxxxx"
  ],
  "imageDescription": "test-description",
  "imageName": "test-imageName"
}

Response:
{
  "requestId": "TE5661D09-28A7-4BDA-ACB1-106EDD916682",
  "response": {
    "requestId": "TE5661D09-28A7-4BDA-ACB1-106EDD916682"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明
404	INVALID_IMAGE_NOT_FOUND	没有找到指定的镜像。
400	INVALID_IMAGE_STATUS	指定镜像的状态不正确。