Supervisor

Package : spaceone.api.plugin.v1

Supervisor

Supervisor Methods:

NO	Method	Request Type	Response Type	Description
1	publish	PublishSupervisorRequest	SupervisorInfo
2	register	RegisterSupervisorRequest	SupervisorInfo
3	update	RegisterSupervisorRequest	SupervisorInfo
4	deregister	SupervisorRequest	google.protobuf.Empty
5	enable	SupervisorRequest	SupervisorInfo
6	disable	SupervisorRequest	SupervisorInfo
7	recover_plugin	RecoverPluginRequest	PluginInfo
8	get	GetSupervisorRequest	SupervisorInfo
9	list	SupervisorQuery	SupervisorsInfo
10	stat	SupervisorStatQuery	google.protobuf.Struct
11	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

No	Field	Type	Required	Description
1	supervisor_id	string	✅
2	domain_id	string	✅
3	only	list of string	❌

PluginInfo

No	Field	Type	Description
1	plugin_id	string
2	version	string
3	state	NONE PROVISIONING ACTIVE RE_PROVISIONING ERROR
4	endpoint	string
5	supervisor_id	string
6	supervisor_name	string
7	managed	bool
8	endpoints	list of string

PluginQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	supervisor_id	string	❌
3	hostname	string	❌
4	plugin_id	string	❌
5	version	string	❌
6	state	NONE PROVISIONING ACTIVE RE_PROVISIONING ERROR	❌
7	endpoint	string	❌
8	domain_id	string	✅

PluginsInfo

No	Field	Type	Description
1	results	list of PluginInfo
2	total_count	int32

PublishSupervisorRequest

No	Field	Type	Required	Description
1	name	string	✅
2	hostname	string	✅
3	secret_key	string	❌
4	plugin_info	list of PluginInfo	❌
5	tags	google.protobuf.Struct	❌
6	is_public	bool	❌
7	domain_id	string	✅
8	labels	google.protobuf.Struct	❌

RecoverPluginRequest

No	Field	Type	Required	Description
1	supervisor_id	string	✅
2	plugin_id	string	✅
3	version	string	✅
4	domain_id	string	✅

RegisterSupervisorRequest

No	Field	Type	Required	Description
1	supervisor_id	string	✅
2	name	string	❌
3	is_public	bool	❌
4	priority	int32	❌
5	labels	google.protobuf.Struct	❌
6	tags	google.protobuf.Struct	❌
7	domain_id	string	✅

SupervisorInfo

No	Field	Type	Description
1	supervisor_id	string
2	name	string
3	hostname	string
4	state	NONE ENABLED DISABLED PENDING DISCONNECTED
5	is_public	bool
6	domain_id	string
7	tags	google.protobuf.Struct
8	labels	google.protobuf.Struct
9	created_at	string
10	updated_at	string

SupervisorQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	supervisor_id	string	❌
3	name	string	❌
4	is_public	bool	❌
5	domain_id	string	✅

SupervisorRequest

No	Field	Type	Required	Description
1	supervisor_id	string	✅
2	domain_id	string	✅

SupervisorStatQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.StatisticsQuery	✅
2	domain_id	string	✅

SupervisorsInfo

No	Field	Type	Description
1	results	list of SupervisorInfo
2	total_count	int32