# ModifyImagesAttributes

## 1. 接口描述

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

{% hint style="info" %}
**注意事项**

* 目前支持修改自定义镜像的属性有：
  * 镜像名称。
  * 镜像描述。
* 如果传入多个镜像ID，仅支持所有镜像修改为同一属性。
* 只可修改自定义镜像的属性。
  {% endhint %}

## 2. 请求参数

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

<table><thead><tr><th width="209">参数名称</th><th width="87">必选</th><th width="160">类型</th><th>描述</th></tr></thead><tbody><tr><td>imageIds</td><td>是</td><td>Array of String</td><td>镜像ID。<br>可从<a href="describeimages">DescribeImages</a>返回的imageId获取。</td></tr><tr><td>imageName</td><td>否</td><td>String</td><td><p>新的镜像名称。<br>镜像名称必须符合以下规则：</p><ul><li>长度不超过24位</li><li>支持中文、字母、数字或连接符号 -_.</li></ul></td></tr><tr><td>imageDescription</td><td>否</td><td>String</td><td>新的镜像描述。<br>描述信息不得超过255个字符。</td></tr></tbody></table>

## 3. 响应结果

<table><thead><tr><th>参数名称</th><th width="186.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>requestId</td><td>String</td><td><p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p></td></tr></tbody></table>

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}

1. **修改镜像属性。**

```json
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"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode)

<table><thead><tr><th width="177.33333333333331">HTTP状态码</th><th>错误码</th><th>说明</th></tr></thead><tbody><tr><td><strong>404</strong></td><td>INVALID_IMAGE_NOT_FOUND</td><td>没有找到指定的镜像。</td></tr><tr><td><strong>400</strong></td><td>INVALID_IMAGE_STATUS</td><td>指定镜像的状态不正确。</td></tr></tbody></table>
