List backup images

Discription

List backup images

Request

Header

Accept: application/xml

X-Auth-Token: Token of Keystone(*1)

X-VA-Project-Id: ID of the project where the resource is created(*2)

X-VA-Domain-Id: ID of the domain where the resource is created(*2)

*1 When the system administrator uses the API, the scope specified for token is ignored.

*2 Required when system administrator uses API. It is ignored when specified by the user.

Method

GET

Path

/server_images

Query

Argument name Discription
verbose To retrieve only some of the information, specify "false", or to retrieve all of the information, specify "true". If omitted, "false" is used.
mode Specify "backup"
availability_zone

Specifies the name of the availability zone where the list of backup images will be retrieved from.

If omitted, a list of backup images will be retrieved from all availability zones.

Response

Status code

200 OK

Body

If verbose=false and mode=backup:


       <ServerImages>
       <ServerImage name="imageName1">
       <Project>Project ID</Project>
       <AvailabilityZone>Availability zone</AvailabilityZone>
       <LServerLink name="virtualServerName"id="virtualServerID"/>
       </ServerImage>
       
       <ServerImage name="ImageName2">
       <Project>projId</Project>
       <AvailabilityZone>Availability zone</AvailabilityZone>
       <LServerLink name="virtualServerName"id="virtualServerId"/>
       </ServerImage>    
       </ServerImages>

If verbose=true and mode=backup:


       <ServerImages>
       <ServerImage name="imageName1">
       <Project>projId</Project>
       <AvailabilityZone>availabilityZone</AvailabilityZone>
       <Comment>comment</Comment>
       <CreateTime>creationDatetime</CreateTime>
       <LServerLink name="virtualServerName"id="virtualServerId"/>
       </ServerImage>
       
       <ServerImage name="imageName2">
       <Project>projId</Project>
       <AvailabilityZone>availabilityZone</AvailabilityZone>
       <Comment>comment</Comment>
       <CreateTime>creationDatetime</CreateTime>
       <LServerLink name="virtualServerName"id="virtualServerId"/>
       </ServerImage>
       </ServerImages>

Item Description Details
imageName Name of image

Name of the backup image

A character string of up to 32 characters consisting of the first half-width alphabet, half-width alphanumeric characters, and underscore ("_")
projId ID of the project where the backup image was created ID of the project
availabilityZone Name of the availability zone where the virtual server exists Availability zone name
virtualServerName Name of the virtual server to be backed up

Name of the virtual server

Specify a string of up to 64 characters, using alphanumeric characters, hyphens (-), underscores (_), and periods (.). It must start with a halfwidth alphanumeric character.
virtualServerId ID of the virtual server to be backed up ID of the backed up virtual server
comment Comment of backup image String of up to 98 characters using halfwidth or fullwidth characters, except for percent (%), backslash (\), double quotation mark ("), and line feed characters.
creationDatetime Datetime when backup image was created (local time) YYYY-MM-DD-hh:mm:ss±hh:mm