new cloudImages(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
addImage(body)
Create a new image
Parameters:
| Name |
Type |
Description |
body |
ImageCreate
|
image details |
- Source:
destroyImage(imageId)
Destroy an image
Parameters:
| Name |
Type |
Description |
imageId |
string
|
Id of Image to be destroyed |
- Source:
getImageActionById(imageId, imageActionId)
Get ImageAction by id
Parameters:
| Name |
Type |
Description |
imageId |
string
|
Id of parent Image |
imageActionId |
string
|
Id of ImageAction to be fetched |
- Source:
getImageActionList(imageId, type, limit, offset)
List of actions performed on images
Parameters:
| Name |
Type |
Description |
imageId |
string
|
Retrieve all actions for a given image |
type |
string
|
Action type filter (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
getImageById(imageId)
Find image by image imageId
Parameters:
| Name |
Type |
Description |
imageId |
string
|
Id of image to be fetched |
- Source:
getImageList(dataCenterId, name, version, status, type, sourceServerId, sizeMb, limit, offset)
Get a list of images. By default, only LIVE images are returned
Parameters:
| Name |
Type |
Description |
dataCenterId |
string
|
Data center the image is in (id) |
name |
string
|
Image name filter (exact match) |
version |
string
|
Image version filter (exact match) |
status |
string
|
Image status filter (exact match) |
type |
string
|
Image type (exact match) |
sourceServerId |
string
|
Source server filter (exact match) |
sizeMb |
integer
|
Size of image in MB (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
publishImage(imageId, body)
Publish this image
Parameters:
| Name |
Type |
Description |
imageId |
string
|
Image to publish (id) |
body |
PublicationCreate
|
Publication details |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: