> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/zec/instance/modifyinstancesattribute.md).

# ModifyInstancesAttribute

## 1. 接口描述

本接口(ModifyInstancesAttribute)用于修改实例属性（名称）。

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

* 支持批量操作。每次请求批量实例的上限为100。
* 如果其中有实例ID不存在，本次操作会立即失败。
  {% endhint %}

## 2. 请求参数

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

| 参数名称         | 必选 | 类型              | 描述                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ------------ | -- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| instanceIds  | 是  | Array of String | <p>待修改属性的实例ID列表。</p><p>可通过调用 <a href="/api-reference/cn/zec/instance/describeinstances.md">DescribeInstances</a> 获取。</p>                                                                                                                                                                                                                                                                                               |
| instanceName | 是  | String          | <p>实例名称。</p><p>范围2到63个字符。</p><p>仅支持输入字母、数字、英文句点(.)、下划线(\_)、斜杠(/)和连字符(-)，且必须以字母或数字开头和结尾。</p><p>批量修改多台实例时，可以指定模式串\[begin\_number,bits]，按instanceIds列表的顺序依次编号。</p><p>begin\_number：有序数值的起始值，取值支持\[0,99999]。</p><p>bits：有序数值所占的位数，取值支持\[1,6]，位数不足时前面补0，数值超出该位数时不截断。</p><p>注意模式串中不得有空格。</p><p>例如修改2台实例时，指定server-\[3,3]，实例名称分别为server-003、server-004。</p><p>支持指定多个模式串，如server-\[3,3]-\[1,1]。</p><p>不指定模式串时，所有实例修改为同一名称。</p> |

## 3. 响应结果

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

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 批量修改实例的名称。**

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

Request：
{
  "instanceIds": [
    "instanceId1",
    "instanceId2"
  ],
  "instanceName": "Test-Instance"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

**2. 批量修改实例的名称，并按顺序添加有序编号。**

instanceId1、instanceId2、instanceId3的名称依次修改为Test-Instance-1、Test-Instance-2、Test-Instance-3。

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

Request：
{
  "instanceIds": [
    "instanceId1",
    "instanceId2",
    "instanceId3"
  ],
  "instanceName": "Test-Instance-[1,1]"
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

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

## 6. 错误码

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

| HTTP状态码 | 错误码                                                         | 说明            |
| ------- | ----------------------------------------------------------- | ------------- |
| 404     | INVALID\_INSTANCE\_NOT\_FOUND                               | 服务器实例不存在。     |
| 400     | INVALID\_PARAMETER\_INSTANCE\_NAME\_MALFORMED               | 实例名称的格式不合法。   |
| 400     | INVALID\_PARAMETER\_INSTANCE\_NAME\_EXCEED                  | 实例名称超过长度限制。   |
| 400     | INVALID\_PARAMETER\_INSTANCE\_NAME\_EXCEED\_MINIMUM\_LENGTH | 实例名称长度小于最小限制。 |
