ModifyInstancesAttribute

1. API Description

The API is used to modify the attributes of one or more instances. Only the instance name to be displayed can be modified for now.

Note

• Batch operations are supported. Each request can modify up to 100 instances.

• If any of the instance IDs does not exist, the operation will fail immediately.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
instanceIds	Yes	Array of String	Instance ID(s). To obtain the instance IDs, you can call DescribeInstances and look for instanceId in the response. The maximum number of instances in each request is 100.
instanceName	Yes	String	Instance name to be displayed. This parameter can contain up to 64 characters. Only letters, numbers, - and periods (.) are supported.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Example

Modify two instance to the name: myInstanceName

POST /api/v2/bmc 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. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.