ModifyInstancesAttribute

1. 接口描述

本接口用于修改虚拟机实例的属性(目前只支持修改实例的显示名称)。

注意事项

  • 支持批量操作。每次请求批量实例的上限为100。

  • 如果其中有实例ID不存在,则本操作会立即失败。

2. 请求参数

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

参数名称必选类型描述

instanceIds

Array of String

一个或多个待操作的实例ID。

可通过DescribeInstances接口返回值中的instanceId获取。每次请求批量实例的上限为100。

instanceName

String

实例名称。

不得超过64个字符。仅支持输入字母、数字、-和英文句点(.)。

3. 响应结果

参数名称类型描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

4. 代码示例

  1. 批量修改实例的名称

同时修改两个实例的名称为myInstanceName

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

Request:
{
  "instanceIds": [
    "instanceId1",
    "instanceId2"
  ],
  "instanceName": "myInstanceName"
}

Response:
{
  "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453",
  "response": {
    "requestId": "TC1748D3E-452D-4F74-8485-7AA73718E453"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码错误码说明

404

INVALID_INSTANCE_NOT_FOUND

指定的实例不存在。

最后更新于