package peloton.api.v0.host.svc
Get desktop application:
View/edit binary Protocol Buffers messages
service HostService
host_svc.proto:139* HostService defines the host related methods such as query hosts, start maintenance, complete maintenance etc.
rpc QueryHosts (, )
host_svc.proto:142Get hosts which are in one of the specified states
message
host_svc.proto:17* Request message for HostService.QueryHosts method.
repeated HostState host_states = 1
List of host states to query the hosts. Will return all hosts if the list is empty.
message
host_svc.proto:25* Response message for HostService.QueryHosts method.
repeated host_infos = 1
List of hosts that match the host query criteria.
rpc StartMaintenance (, )
host_svc.proto:145Start maintenance on the specified hosts
message
host_svc.proto:31Request message for HostService.StartMaintenance method.
repeated string hostnames = 1
List of hosts to be put into maintenance
string hostname = 2
Host to be put into maintenance
message
host_svc.proto:42Response message for HostService.StartMaintenance method. Return errors: NOT_FOUND: if the host is not found.
string hostname = 1
Host successfully submitted for maintenance
Complete maintenance on the specified hosts
message
host_svc.proto:48Request message for HostService.CompleteMaintenance method.
repeated string hostnames = 1
List of hosts put be brought back up
string hostname = 2
Host to be removed from maintenance and brought back up
message
host_svc.proto:58Response message for HostService.CompleteMaintenance method. Return errors: NOT_FOUND: if the host is not found.
string hostname = 1
Host successfully submitted for maintenance completion
rpc ListHostPools (, )
host_svc.proto:151Get information about all host pools
message
host_svc.proto:64Request message for HostService.ListHostPools method.
(message has no fields)
message
host_svc.proto:68Response message for HostService.ListHostPoolsRequest method. Return errors:
repeated pools = 1
Information about all pools
rpc CreateHostPool (, )
host_svc.proto:155Create a host pool
message
host_svc.proto:74Request message for HostService.CreateHostPool method.
string name = 1
Name of the pool to create.
message
host_svc.proto:83Response message for HostService.CreateHostPool method. Return errors: ALREADY_EXISTS: If a pool with the specified name already exists INVALID_ARGUMENT: If pool name is invalid
(message has no fields)
rpc DeleteHostPool (, )
host_svc.proto:160Delete a host pool. Hosts in the pool are moved to a default pool.
message
host_svc.proto:86Request message for HostService.DeleteHostPool method.
string name = 1
Name of the pool to delete.
message
host_svc.proto:95Response message for HostService.DeleteHostPool method. Return errors: NOT_FOUND: If a pool with the specified name does not exist INVALID_ARGUMENT: If you try to delete the default pool
(message has no fields)
rpc ChangeHostPool (, )
host_svc.proto:164Change the pool to which a host belongs
message
host_svc.proto:98Request message for HostService.ChangeHostPool method.
string hostname = 1
Hostname of host to move.
string sourcePool = 2
Name of source host-pool of given host.
string destinationPool = 3
Name of destination host-pool of given host.
message
host_svc.proto:114Response message for HostService.DeleteHostPool method. Return errors: NOT_FOUND: If host doesn't exist INVALID_ARGUMENT: If host is not in the specified source pool, or destination pool doesn't exist
(message has no fields)
rpc MoveHosts (, )
host_svc.proto:169Move specified number of hosts from source pool to destination pool
message
host_svc.proto:117Request message for HostService.MoveHostsRequest method.
string sourcePool = 1
Name of host pool from which hosts are to be moved.
int32 srcPoolDesiredHosts = 2
desired number of hosts in source pool
string destinationPool = 3
Name of host pool to which hosts are to be moved.
int32 destPoolDesiredHosts = 4
desired number of hosts in destination pool
message
host_svc.proto:133Response message for HostService.MoveHosts method. return Error if hosts can't be moved
(message has no fields)