ModifyImagesAttributes

1. API Description

The API is used to modify the attributes of one or more images.

Note

  • Only the custom image name and description can be modified for now.

  • All the specified disks will be modified the same attributes.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

imageIds

Yes

Array of String

ID list of images. Call DescribeImages and find imageId in the response.

imageName

No

String

Image name to be displayed.

This parameter must contain up to 24 characters. Only Chinese characters, letters, numbers, - and _ are supported.

imageDescription

No

String

Image description. This parameter must contain up to 255 characters.

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

Modify the attributes of images.

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. 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_IMAGE_NOT_FOUND

Image not found.

400

INVALID_IMAGE_STATUS

Operations on the image with current status are not supported.

Last updated