Supervisor

Package : spaceone.api.plugin.v1

Supervisor

Supervisor Methods:

Method	Request	Response
publish	PublishSupervisorRequest	SupervisorInfo
register	RegisterSupervisorRequest	SupervisorInfo
update	RegisterSupervisorRequest	SupervisorInfo
deregister	SupervisorRequest	google.protobuf.Empty
enable	SupervisorRequest	SupervisorInfo
disable	SupervisorRequest	SupervisorInfo
recover_plugin	RecoverPluginRequest	PluginInfo
get	GetSupervisorRequest	SupervisorInfo
list	SupervisorQuery	SupervisorsInfo
stat	SupervisorStatQuery	google.protobuf.Struct
list_plugins	PluginQuery	PluginsInfo

publish

POST /plugin/v1/supervisors

Type	Message
Request	PublishSupervisorRequest
Response	SupervisorInfo

register

POST /plugin/v1/supervisor/{supervisor_id}/register

Type	Message
Request	RegisterSupervisorRequest
Response	SupervisorInfo

update

PUT /plugin/v1/supervisor/{supervisor_id}

Type	Message
Request	RegisterSupervisorRequest
Response	SupervisorInfo

deregister

DELETE /plugin/v1/supervisor/{supervisor_id}/register

Type	Message
Request	SupervisorRequest
Response	google.protobuf.Empty

enable

PUT /plugin/v1/supervisor/{supervisor_id}/enable

Type	Message
Request	SupervisorRequest
Response	SupervisorInfo

disable

PUT /plugin/v1/supervisor/{supervisor_id}/disable

Type	Message
Request	SupervisorRequest
Response	SupervisorInfo

recover_plugin

POST /plugin/v1/supervisor/{supervisor_id}/plugin/{plugin_id}/recover

Type	Message
Request	RecoverPluginRequest
Response	PluginInfo

get

GET /plugin/v1/supervisor/{supervisor_id}

Type	Message
Request	GetSupervisorRequest
Response	SupervisorInfo

list

GET /plugin/v1/supervisors

POST /plugin/v1/supervisors/search

Type	Message
Request	SupervisorQuery
Response	SupervisorsInfo

stat

POST /plugin/v1/supervisors/stat

Type	Message
Request	SupervisorStatQuery
Response	google.protobuf.Struct

list_plugins

GET /plugin/v1/supervisor/{supervisor_id}/plugins

POST /plugin/v1/supervisor/{supervisor_id}/plugins/search

Type	Message
Request	PluginQuery
Response	PluginsInfo

Message

GetSupervisorRequest

Field	Type	Required	Description
supervisor_id	string	✔
domain_id	string	✔
only	list of string	✘

PluginInfo

Field	Type	Description
plugin_id	string
version	string
state	NONE PROVISIONING ACTIVE RE_PROVISIONING ERROR
endpoint	string
supervisor_id	string
supervisor_name	string
managed	bool
endpoints	list of string

PluginQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
supervisor_id	string	✘
hostname	string	✘
plugin_id	string	✘
version	string	✘
state	NONE PROVISIONING ACTIVE RE_PROVISIONING ERROR	✘
endpoint	string	✘
domain_id	string	✔

PluginsInfo

Field	Type	Description
results	list of PluginInfo
total_count	int32

PublishSupervisorRequest

Field	Type	Required	Description
name	string	✔
hostname	string	✔
secret_key	string	✘
plugin_info	list of PluginInfo	✘
tags	google.protobuf.Struct	✘
is_public	bool	✘
domain_id	string	✔
labels	google.protobuf.Struct	✘

RecoverPluginRequest

Field	Type	Required	Description
supervisor_id	string	✔
plugin_id	string	✔
version	string	✔
domain_id	string	✔

RegisterSupervisorRequest

Field	Type	Required	Description
supervisor_id	string	✔
name	string	✘
is_public	bool	✘
priority	int32	✘
labels	google.protobuf.Struct	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

SupervisorInfo

Field	Type	Description
supervisor_id	string
name	string
hostname	string
state	NONE ENABLED DISABLED PENDING DISCONNECTED
is_public	bool
domain_id	string
tags	google.protobuf.Struct
labels	google.protobuf.Struct
created_at	string
updated_at	string

SupervisorQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
supervisor_id	string	✘
name	string	✘
is_public	bool	✘
domain_id	string	✔

SupervisorRequest

Field	Type	Required	Description
supervisor_id	string	✔
domain_id	string	✔

SupervisorStatQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.StatisticsQuery	✔
domain_id	string	✔

SupervisorsInfo

Field	Type	Description
results	list of SupervisorInfo
total_count	int32