Container methods.
| Service. | Container methods. |
| Functions | |
| order | Order a Container |
| orderResourceChange | Orders a resource change for a Container |
| addIPAddress | Add an additional IP address to the container |
| removeIPAddress | Remove an extra IP from the container |
| destroy | Delete a Container |
| rename | Rename a Container |
| start | Start a Container |
| stop | Stop a Container |
| reboot | Reboot a Container |
| find | Search for a container. |
| getUuid | Get a UUID for a Container. |
| setSettings | Set a list of settings on the Container |
| getCurrentResourceUsage | Get the current resource usage |
| getHistoricalResourceUsage | Get a list of usage data for a given interval The creation time of the container must not come after startTime + intervalTime or errors may occur |
| listEnvironments | Returns a list of Environments that this container is serving. |
| getProcessTableGraph | Get a process table graph for a container over a period of time |
| getProcessTable | Get a process table for a moment in time |
| listOSes | List all the available OSes |
| listTypes | List all the available types to containers |
| listConvertTypes | List all the available upgrades for a container |
| convertType | Convert a container to a different type, if possible |
| listCommands | List all the available commands that can be run against a container |
| runCommand | Run a command against a container |
| getHistoricalStatus | List container status changes |
| getHistoricalAlerts | List container status changes |
| getOOMEvents | List container out of memory events |
| listBackups | List all backups made of a container |
| createBackup | Create a backup |
| destroyBackup | Delete a backup |
| restoreBackup | Restore a backup |
Order a Container
| customerId | no docs (idx: 1, type: Types.CustomerId) |
| name | no docs (idx: 2, type: Types.ContainerName) |
| type | no docs (idx: 7, type: Types.ContainerTypeId) |
| size | no docs (idx: 4, type: Types.ContainerSize, optional) |
| diskSpace | no docs (idx: 10, type: Types.ContainerDiskSpace, optional) |
| paymentMethodId | no docs (idx: 5, type: Types.PBA_paymentMethodId, optional) |
| promoCode | , (idx: 6, type: Thrift.string, optional) |
| provisioningData | no docs (idx: 8, type: Thrift.map (Thrift.string => Thrift.string), optional) |
| osId | no docs (idx: 9, type: Types.OSId) |
Exceptions.InvalidArguments (idx: 1) Exceptions.BillingFailed (idx: 2)
Orders a resource change for a Container
| id | no docs (idx: 1, type: Types.ContainerId) |
| size | no docs (idx: 2, type: Types.ContainerSize, optional) |
| diskSpace | no docs (idx: 3, type: Types.ContainerDiskSpace, optional) |
Exceptions.InvalidArguments (idx: 1) Exceptions.BillingFailed (idx: 2)
Add an additional IP address to the container
| id | no docs (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Remove an extra IP from the container
| id | no docs (idx: 1, type: Types.ContainerId) |
| address | no docs (idx: 2, type: Types.IPAddress) |
Exceptions.InvalidArguments (idx: 1)
Delete a Container
| id | ID of the Container you wish to destroy (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Rename a Container
| id | no docs (idx: 1, type: Types.ContainerId) |
| name | no docs (idx: 2, type: Types.ContainerName) |
Exceptions.InvalidArguments (idx: 1)
Start a Container
| id | ID of the Container you wish to start (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Stop a Container
| id | ID of the Container you wish to stop (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Reboot a Container
| id | ID of the Container you wish to reboot (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Search for a container.
| uuid | UUID of the container to find (idx: 1, type: Types.ContainerUuid, optional) |
| address | IP address belonging to the container (idx: 2, type: Types.IPAddress, optional) |
| customerId | ID of a customer (idx: 3, type: Types.CustomerId, optional) |
| id | no docs (idx: 4, type: Types.ContainerId, optional) |
Thrift.list (Types.ContainerDetails) a list of ContainerId
Exceptions.InvalidArguments (idx: 1)
Get a UUID for a Container.
| id | no docs (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Set a list of settings on the Container
| id | the ID of the Container (idx: 1, type: Types.ContainerId) |
| settings | a list of the settings (idx: 2, type: Types.SettingList) |
Exceptions.InvalidArguments (idx: 1)
Get the current resource usage
| id | no docs (idx: 1, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
Get a list of usage data for a given interval The creation time of the container must not come after startTime + intervalTime or errors may occur
| id | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime) |
| endTime | no docs (idx: 3, type: Types.UnixTime) |
| intervalTime | The time in seconds between each record (idx: 4, type: Thrift.i32) |
| types | A list of which resource usage types you’d like data for (idx: 5, type: Thrift.list (Types.ResourceUsageType)) |
Thrift.list (Types.ResourceHistoricalUsage)
Exceptions.InvalidArguments (idx: 1)
Returns a list of Environments that this container is serving. Returns list<ContainerEnvironmentDetails>
| id | no docs (idx: 1, type: Types.ContainerId) |
Thrift.list (Types.ContainerEnvironmentDetails)
Exceptions.InvalidArguments (idx: 1)
Get a process table graph for a container over a period of time
| id | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime) |
| endTime | no docs (idx: 3, type: Types.UnixTime) |
| intervalTime | The time in seconds between each record (idx: 4, type: Thrift.i32) |
| limit | Limit the number of processes returned (idx: 5, type: Thrift.i16, optional) |
| metrics | What metrics are we graphing (idx: 6, type: Thrift.list (Types.ProcessTableMetric)) |
| thresholds | Require all processes that are returned to have some values above this threshold. Units are contextual to the metric. (idx: 7, type: Thrift.map (Types.ProcessTableMetric => Thrift.i32), optional) |
Exceptions.InvalidArguments (idx: 1)
Get a process table for a moment in time
| id | no docs (idx: 1, type: Types.ContainerId) |
| time | no docs (idx: 2, type: Types.UnixTime) |
Exceptions.InvalidArguments (idx: 1)
List all the available types to containers
Thrift.list (Types.ContainerType)
Exceptions.InvalidArguments (idx: 1)
List all the available upgrades for a container
| typeId | no docs (idx: 1, type: Types.ContainerTypeId) |
Thrift.list (Types.ContainerType)
Exceptions.InvalidArguments (idx: 1)
Convert a container to a different type, if possible
| id | no docs (idx: 1, type: Types.ContainerId) |
| typeId | no docs (idx: 2, type: Types.ContainerTypeId) |
Exceptions.InvalidArguments (idx: 1)
List all the available commands that can be run against a container
| id | no docs (idx: 1, type: Types.ContainerId) |
Thrift.list (Types.ContainerCommand)
Exceptions.InvalidArguments (idx: 1)
Run a command against a container
| id | no docs (idx: 1, type: Types.ContainerId) |
| commandId | no docs (idx: 2, type: Types.ContainerCommandId, optional) |
| commandName | no docs (idx: 3, type: Thrift.string, optional) |
| arguments | no docs (idx: 4, type: Thrift.list (Types.ContainerCommandArgument)) |
Types.ContainerCommandResponse
Exceptions.InvalidArguments (idx: 1)
List container status changes
| id | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime, optional) |
| endTime | no docs (idx: 3, type: Types.UnixTime, optional) |
| limit | Limit the number of records returned (idx: 4, type: Thrift.i16, optional) |
| status | Limit only to these status (idx: 5, type: Thrift.list (Types.ContainerHistoricalStatusName), optional) |
| transitions | Limit only to these transitions (idx: 6, type: Thrift.list (Types.ContainerHistoricalTransitionName), optional) |
Thrift.list (Types.ContainerHistoricalStatus)
Exceptions.InvalidArguments (idx: 1)
List container status changes
| id | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime, optional) |
| endTime | no docs (idx: 3, type: Types.UnixTime, optional) |
| limit | Limit the number of records returned (idx: 4, type: Thrift.i16, optional) |
| counters | Limit only to these counters (idx: 5, type: Thrift.list (Types.ContainerHistoricalAlertCounter), optional) |
Thrift.list (Types.ContainerHistoricalAlert)
Exceptions.InvalidArguments (idx: 1)
List container out of memory events
| id | no docs (idx: 1, type: Types.ContainerId) |
| startTime | no docs (idx: 2, type: Types.UnixTime, optional) |
| endTime | no docs (idx: 3, type: Types.UnixTime, optional) |
| limit | Limit the number of records returned (idx: 4, type: Thrift.i16, optional) |
Thrift.list (Types.ContainerOOMEvent)
Exceptions.InvalidArguments (idx: 1)
List all backups made of a container
| id | no docs (idx: 1, type: Types.ContainerId) |
Thrift.list (Types.ContainerBackup)
Exceptions.InvalidArguments (idx: 1)
Create a backup
| id | no docs (idx: 1, type: Types.ContainerId) |
| description | no docs (idx: 2, type: Thrift.string) |
| type | no docs (idx: 3, type: Types.ContainerBackupType) |
Exceptions.InvalidArguments (idx: 1)
Delete a backup
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| backupId | no docs (idx: 2, type: Types.ContainerBackupId) |
Exceptions.InvalidArguments (idx: 1)
Restore a backup
| containerId | no docs (idx: 1, type: Types.ContainerId) |
| backupId | no docs (idx: 2, type: Types.ContainerBackupId) |
Exceptions.InvalidArguments (idx: 1)