Collector

Package : spaceone.api.inventory.v1

Collector

Collector Methods:

NO	Method	Request Type	Response Type	Description
1	create	CreateCollectorRequest	CollectorInfo
2	update	UpdateCollectorRequest	CollectorInfo
3	update_plugin	UpdatePluginRequest	CollectorInfo
4	verify_plugin	VerifyPluginRequest	google.protobuf.Empty
5	delete	CollectorRequest	google.protobuf.Empty
6	get	GetCollectorRequest	CollectorInfo
7	enable	CollectorRequest	CollectorInfo
8	disable	CollectorRequest	CollectorInfo
9	list	CollectorQuery	CollectorsInfo
10	stat	CollectorStatQuery	google.protobuf.Struct
11	collect	CollectRequest	JobInfo
12	add_schedule	CreateScheduleRequest	ScheduleInfo
13	get_schedule	ScheduleRequest	ScheduleInfo
14	update_schedule	UpdateScheduleRequest	ScheduleInfo
15	delete_schedule	DeleteScheduleRequest	google.protobuf.Empty
16	list_schedules	ScheduleQuery	SchedulesInfo

create

POST /inventory/v1/collectors

Type	Message
Request	CreateCollectorRequest
Response	CollectorInfo

update

PUT /inventory/v1/collector/{collector_id}

Type	Message
Request	UpdateCollectorRequest
Response	CollectorInfo

update_plugin

PUT /inventory/v1/collector/{collector_id}/plugin

Type	Message
Request	UpdatePluginRequest
Response	CollectorInfo

verify_plugin

POST /inventory/v1/collector/{collector_id}/plugin/verify

Type	Message
Request	VerifyPluginRequest
Response	google.protobuf.Empty

delete

DELETE /inventory/v1/collector/{collector_id}

Type	Message
Request	CollectorRequest
Response	google.protobuf.Empty

get

GET /inventory/v1/collector/{collector_id}

Type	Message
Request	GetCollectorRequest
Response	CollectorInfo

enable

PUT /inventory/v1/collector/{collector_id}/enable

Type	Message
Request	CollectorRequest
Response	CollectorInfo

disable

PUT /inventory/v1/collector/{collector_id}/disable

Type	Message
Request	CollectorRequest
Response	CollectorInfo

list

GET /inventory/v1/collectors

POST /inventory/v1/collectors/search

Type	Message
Request	CollectorQuery
Response	CollectorsInfo

stat

POST /inventory/v1/collectors/stat

Type	Message
Request	CollectorStatQuery
Response	google.protobuf.Struct

collect

POST /inventory/v1/collector/{collector_id}/collect

Type	Message
Request	CollectRequest
Response	JobInfo

add_schedule

POST /inventory/v1/collector/{collector_id}/schedule

Type	Message
Request	CreateScheduleRequest
Response	ScheduleInfo

get_schedule

GET /inventory/v1/collector/{collector_id}/schedule/{schedule_id}

Type	Message
Request	ScheduleRequest
Response	ScheduleInfo

update_schedule

POST /inventory/v1/collector/{collector_id}/schedule/{schedule_id}

Type	Message
Request	UpdateScheduleRequest
Response	ScheduleInfo

delete_schedule

DELETE /inventory/v1/collector/{collector_id}/schedule/{schedule_id}

Type	Message
Request	DeleteScheduleRequest
Response	google.protobuf.Empty

list_schedules

GET /inventory/v1/collector/{collector_id}/schedules

POST /inventory/v1/collector/{collector_id}/schedules/search

Type	Message
Request	ScheduleQuery
Response	SchedulesInfo

Message

CollectRequest

No	Field	Type	Required	Description
1	collector_id	string	✅
2	filter	google.protobuf.Struct	❌
3	secret_id	string	❌
4	collect_mode	string	❌
5	domain_id	string	✅
6	use_cache	bool	❌

CollectorInfo

No	Field	Type	Description
1	collector_id	string
2	name	string
3	state	NONE ENABLED DISABLED
4	plugin_info	PluginInfo
5	priority	int32
6	tags	list of spaceone.api.core.v1.Tag
7	created_at	google.protobuf.Timestamp
8	last_collected_at	google.protobuf.Timestamp
9	domain_id	string
10	provider	string
11	capability	google.protobuf.Struct
12	is_public	bool
13	project_id	string

CollectorQuery

No	Field	Type	Description
1	query	spaceone.api.core.v1.Query
2	collector_id	string
3	name	string
4	state	NONE ENABLED DISABLED
5	priority	int32
6	plugin_id	string
7	domain_id	string

CollectorRequest

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

CollectorStatQuery

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

CollectorsInfo

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

CreateCollectorRequest

No	Field	Type	Required	Description
1	name	string	✅
2	plugin_info	PluginInfo	✅
3	priority	int32	❌
4	tags	list of spaceone.api.core.v1.Tag	❌
5	domain_id	string	✅
6	is_public	bool	❌	default is true
7	project_id	string	❌	if is_public is false, project_id is required

CreateScheduleRequest

No	Field	Type	Required	Description
1	domain_id	string	✅
2	collector_id	string	✅
3	name	string	❌
4	collect_mode	string	❌
5	schedule	Scheduled	✅
6	filter	google.protobuf.Struct	❌

DeleteScheduleRequest

No	Field	Type	Required	Description
1	domain_id	string	✅
2	schedule_id	string	✅
3	collector_id	string	✅

ErrorInfo

No	Field	Type	Description
1	error_code	string
2	message	string
3	additional	google.protobuf.Struct

GetCollectorRequest

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

JobInfo

No	Field	Type	Description
1	job_id	string
2	status	NONE CREATED CANCELED IN_PROGRESS SUCCESS ERROR TIMEOUT
3	filter	google.protobuf.Struct
4	total_tasks	int32
5	remained_tasks	int32
6	errors	list of ErrorInfo
7	collector_info	CollectorInfo
8	project_id	string
9	domain_id	string
10	created_at	google.protobuf.Timestamp
11	updated_at	google.protobuf.Timestamp
12	finished_at	google.protobuf.Timestamp

PluginInfo

No	Field	Type	Description
1	plugin_id	string
2	version	string
3	options	google.protobuf.Struct
4	secret_id	string
5	secret_group_id	string
6	provider	string
7	service_account_id	string
8	metadata	google.protobuf.Struct

ScheduleInfo

No	Field	Type	Description
1	domain_id	string
2	schedule_id	string
3	name	string
4	collect_mode	string
5	schedule	Scheduled
6	created_at	google.protobuf.Timestamp
7	last_scheduled_at	google.protobuf.Timestamp
8	collector_info	CollectorInfo
9	filter	google.protobuf.Struct

ScheduleQuery

No	Field	Type	Required	Description
1	query	spaceone.api.core.v1.Query	❌
2	collector_id	string	✅
3	schedule_id	string	❌
4	domain_id	string	✅

ScheduleRequest

No	Field	Type	Required	Description
1	domain_id	string	✅
2	schedule_id	string	✅
3	collector_id	string	✅

Scheduled

No	Field	Type	Description
1	cron	string
2	interval	int32
3	minutes	list of int32
4	hours	list of int32

SchedulesInfo

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

UpdateCollectorRequest

No	Field	Type	Required	Description
1	collector_id	string	✅
2	name	string	❌
3	plugin_info	PluginInfo	❌
4	priority	int32	❌
5	tags	list of spaceone.api.core.v1.Tag	❌
6	domain_id	string	✅

UpdatePluginRequest

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

UpdateScheduleRequest

No	Field	Type	Required	Description
1	domain_id	string	✅
2	schedule_id	string	✅
3	collector_id	string	✅
4	name	string	❌
5	collect_mode	string	❌
6	schedule	Scheduled	❌
7	filter	google.protobuf.Struct	❌

VerifyInfo

No	Field	Type	Description
1	status	bool

VerifyPluginRequest

No	Field	Type	Required	Description
1	collector_id	string	✅
2	secret_id	string	❌
3	domain_id	string	✅