Environment methods.
| Service. | Environment methods. |
| Functions | |
| create | create an environment for a site |
| cloneEnvironment | Create a new environment, cloning the settings and files of an existing environment |
| destroy | Delete an environment |
| enable | enable an environment |
| disable | disable an environment |
| find | Search for an environment |
| getAddress | fetch the address for this environment |
| setLive | set an environment ‘live’ |
| liveHistory | list the history of live environments (all history, or just an interval) |
| setContainerMaster | Make a container the master for this environment. |
| getSettings | get all the settings associated with the environment |
| setSettings | set a list of settings on the environment |
| addDatabase | add a database to an environment |
| removeDatabase | remove a database from an environment |
| addContainers | add containers to an environment |
| listContainers | List containers in this Environment |
| removeContainers | remove containers to an environment |
| getAliases | Get all aliases associated with the environment |
| addAlias | add an alias to a site environment |
| destroyAlias | Remove an alias from a site environment |
| restartServices | Restart services on containers participating in this environment |
| checkServiceConfig | Check service configuration for this Environment. |
create an environment for a site
| id | the id of the site (idx: 1, type: Types.SiteId) |
| name | the name of the environment (idx: 2, type: Types.EnvironmentName) |
| containers | a list of containerids to configure the site environment on (idx: 3, type: Thrift.list (Types.ContainerId)) |
| type | no docs (idx: 4, type: Types.ContainerTypeId) |
Types.EnvironmentId the id of the newly created environment
Exceptions.InvalidArguments (idx: 1)
Create a new environment, cloning the settings and files of an existing environment
| source | no docs (idx: 1, type: Types.EnvironmentId) |
| name | no docs (idx: 2, type: Types.EnvironmentName) |
| containers | no docs (idx: 3, type: Thrift.list (Types.ContainerId)) |
| type | no docs (idx: 4, type: Types.ContainerTypeId) |
Exceptions.InvalidArguments (idx: 1)
Delete an environment
| id | the id of a the environment you wish to destroy (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
enable an environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
disable an environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
Search for an environment
| customerId | no docs (idx: 1, type: Types.CustomerId, optional) |
| siteId | no docs (idx: 2, type: Types.SiteId, optional) |
| containerId | no docs (idx: 3, type: Types.ContainerId, optional) |
| id | no docs (idx: 4, type: Types.EnvironmentId, optional) |
| name | no docs (idx: 5, type: Types.EnvironmentName, optional) |
| isEnabled | no docs (idx: 6, type: Thrift.bool, optional) |
Thrift.list (Types.EnvironmentDetails)
Exceptions.InvalidArguments (idx: 1)
fetch the address for this environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
set an environment ‘live’
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
list the history of live environments (all history, or just an interval)
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| interval | no docs (idx: 2, type: Types.TimeInterval, optional) |
Exceptions.InvalidArguments (idx: 1)
Make a container the master for this environment. If another container is already the master, this will replace that.
| environmentId | no docs (idx: 1, type: Types.EnvironmentId) |
| containerId | no docs (idx: 2, type: Types.ContainerId) |
Exceptions.InvalidArguments (idx: 1)
get all the settings associated with the environment
| id | the id of the environment (idx: 1, type: Types.EnvironmentId) |
Exceptions.InvalidArguments (idx: 1)
set a list of settings on the environment
| id | the id of the environment (idx: 1, type: Types.EnvironmentId) |
| settings | a list of the settings (idx: 2, type: Types.SettingList) |
Exceptions.InvalidArguments (idx: 1)
add a database to an environment
| id | id of the environment (idx: 1, type: Types.EnvironmentId) |
| databaseId | no docs (idx: 2, type: Types.DatabaseId) |
Exceptions.InvalidArguments (idx: 1)
remove a database from an environment
| id | id of the environment (idx: 1, type: Types.EnvironmentId) |
| databaseId | no docs (idx: 2, type: Types.DatabaseId) |
Exceptions.InvalidArguments (idx: 1)
add containers to an environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| containers | no docs (idx: 2, type: Thrift.list (Types.ContainerId)) |
Exceptions.InvalidArguments (idx: 1)
List containers in this Environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Thrift.list (Types.ContainerId)
Exceptions.InvalidArguments (idx: 1)
remove containers to an environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| containers | no docs (idx: 2, type: Thrift.list (Types.ContainerId)) |
Exceptions.InvalidArguments (idx: 1)
Get all aliases associated with the environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Types.EnvironmentAliasList a list of sitealiases
Exceptions.InvalidArguments (idx: 1)
add an alias to a site environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| aliases | list of aliases (idx: 4, type: Thrift.list (Types.EnvironmentAlias)) |
| createDNS | no docs (idx: 3, type: Thrift.bool, optional) |
Thrift.list (Types.EnvironmentAliasId)
Exceptions.InvalidArguments (idx: 1)
Remove an alias from a site environment
| id | the id of the alias to destroy (idx: 1, type: Types.EnvironmentAliasId) |
Exceptions.InvalidArguments (idx: 1)
Restart services on containers participating in this environment
| id | no docs (idx: 1, type: Types.EnvironmentId) |
| graceful | execute a graceful restart of services (if supported) (idx: 2, type: Thrift.bool, optional) |
| configtest | execute a conditional restart based on clean configuration (idx: 3, type: Thrift.bool, optional) |
Thrift.list (Types.ContainerCommandResponse)
Exceptions.InvalidArguments (idx: 1)
Check service configuration for this Environment.
| id | no docs (idx: 1, type: Types.EnvironmentId) |
Thrift.list (Types.ContainerCommandResponse)
Exceptions.InvalidArguments (idx: 1)