Protocol

Package : spaceone.api.notification.v1

Protocol

Protocol Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateProtocolRequest	ProtocolInfo
2	update	UpdateProtocolRequest	ProtocolInfo
3	update_plugin	UpdateProtocolPluginRequest	ProtocolInfo
4	enable	ProtocolRequest	ProtocolInfo
5	disable	ProtocolRequest	ProtocolInfo
6	delete	ProtocolRequest	google.protobuf.Empty
7	get	GetProtocolRequest	ProtocolInfo
8	list	ProtocolQuery	ProtocolsInfo
9	stat	ProtocolStatQuery	google.protobuf.Struct

create

POST /notification/v1/protocols

Type	Message
Request	CreateProtocolRequest
Response	ProtocolInfo

update

PUT /notification/v1/protocol/{protocol_id}

Type	Message
Request	UpdateProtocolRequest
Response	ProtocolInfo

update_plugin

PUT /notification/v1/protocol/{protocol_id}/plugin

Type	Message
Request	UpdateProtocolPluginRequest
Response	ProtocolInfo

enable

PUT /notification/v1/protocol/{protocol_id}/enable

Type	Message
Request	ProtocolRequest
Response	ProtocolInfo

disable

PUT /notification/v1/protocol/{protocol_id}/disable

Type	Message
Request	ProtocolRequest
Response	ProtocolInfo

delete

DELETE /notification/v1/protocol/{protocol_id}

Type	Message
Request	ProtocolRequest
Response	google.protobuf.Empty

get

GET /notification/v1/protocol/{protocol_id}

Type	Message
Request	GetProtocolRequest
Response	ProtocolInfo

list

GET /notification/v1/protocols

POST /notification/v1/protocols/search

Type	Message
Request	ProtocolQuery
Response	ProtocolsInfo

stat

POST /notification/v1/protocols/stat

Type	Message
Request	ProtocolStatQuery
Response	google.protobuf.Struct

Message

CreateProtocolRequest

No	Field	Type	Required	Description
1	name	string	✅
2	plugin_info	PluginInfo	✅
3	tags	google.protobuf.Struct	❌
4	project_id	string	✅
5	domain_id	string	✅

GetProtocolRequest

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

PluginInfo

No	Field	Type	Description
1	plugin_id	string
2	version	string
3	options	google.protobuf.Struct
4	metadata	google.protobuf.Struct

ProtocolInfo

No	Field	Type	Description
1	protocol_id	string
2	name	string
3	state	NONE ENABLED DISABLED
4	protocol_type	PROTOCOL_TYPE_NONE INTERNAL EXTERNAL
5	resource_type	string
6	capability	google.protobuf.Struct
7	plugin_info	PluginInfo
8	tags	google.protobuf.Struct
9	domain_id	string
10	created_at	string

ProtocolQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	protocol_id	string	❌
3	name	string	❌
4	state	NONE ENABLED DISABLED	❌
5	protocol_type	PROTOCOL_TYPE_NONE INTERNAL EXTERNAL	❌
6	domain_id	string	✅

ProtocolRequest

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

ProtocolStatQuery

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

ProtocolsInfo

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

UpdateProtocolPluginRequest

No	Field	Type	Required	Description
1	protocol_id	string	✅
2	version	string	❌
3	options	google.protobuf.Struct	❌
4	domain_id	string	✅

UpdateProtocolRequest

No	Field	Type	Required	Description
1	protocol_id	string	✅
2	name	string	❌
3	tags	google.protobuf.Struct	❌
4	domain_id	string	✅