Collector

Package : spaceone.api.inventory.v1

Collector

Collector Methods:

Method	Request	Response
create	CreateCollectorRequest	CollectorInfo
update	UpdateCollectorRequest	CollectorInfo
update_plugin	UpdatePluginRequest	CollectorInfo
verify_plugin	VerifyPluginRequest	google.protobuf.Empty
delete	CollectorRequest	google.protobuf.Empty
get	GetCollectorRequest	CollectorInfo
enable	CollectorRequest	CollectorInfo
disable	CollectorRequest	CollectorInfo
list	CollectorQuery	CollectorsInfo
stat	CollectorStatQuery	google.protobuf.Struct
collect	CollectRequest	JobInfo
add_schedule	CreateScheduleRequest	ScheduleInfo
get_schedule	ScheduleRequest	ScheduleInfo
update_schedule	UpdateScheduleRequest	ScheduleInfo
delete_schedule	DeleteScheduleRequest	google.protobuf.Empty
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

Field	Type	Required	Description
collector_id	string	✔
filter	google.protobuf.Struct	✘
secret_id	string	✘
collect_mode	string	✘
domain_id	string	✔
use_cache	bool	✘

CollectorInfo

Field	Type	Description
collector_id	string
name	string
state	NONE ENABLED DISABLED
plugin_info	PluginInfo
priority	int32
tags	google.protobuf.Struct
created_at	string
last_collected_at	string
domain_id	string
provider	string
capability	google.protobuf.Struct
is_public	bool
project_id	string

CollectorQuery

Field	Type	Description
query	spaceone.api.core.v1.Query
collector_id	string
name	string
state	NONE ENABLED DISABLED
priority	int32
plugin_id	string
domain_id	string

CollectorRequest

Field	Type	Required	Description
collector_id	string	✔
domain_id	string	✔

CollectorStatQuery

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

CollectorsInfo

Field	Type	Description
results	list of CollectorInfo
total_count	int32

CreateCollectorRequest

Field	Type	Required	Description
name	string	✔
plugin_info	PluginInfo	✔
priority	int32	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔
is_public	bool	✘	default is true
project_id	string	✔	if is_public is false, project_id is requireremained as is_public

CreateScheduleRequest

Field	Type	Required	Description
domain_id	string	✔
collector_id	string	✔
name	string	✘
collect_mode	string	✘
schedule	Scheduled	✔
filter	google.protobuf.Struct	✘

DeleteScheduleRequest

Field	Type	Required	Description
domain_id	string	✔
schedule_id	string	✔
collector_id	string	✔

ErrorInfo

Field	Type	Description
error_code	string
message	string
additional	google.protobuf.Struct

GetCollectorRequest

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

JobInfo

Field	Type	Description
job_id	string
status	NONE CREATED CANCELED IN_PROGRESS SUCCESS ERROR TIMEOUT
filter	google.protobuf.Struct
total_tasks	int32
remained_tasks	int32
errors	list of ErrorInfo
collector_info	CollectorInfo
project_id	string
domain_id	string
created_at	string
updated_at	string
finished_at	string

PluginInfo

Field	Type	Description
plugin_id	string
version	string
options	google.protobuf.Struct
secret_id	string
secret_group_id	string
provider	string
service_account_id	string
metadata	google.protobuf.Struct
upgrade_mode	NONE MANUAL AUTO

ScheduleInfo

Field	Type	Description
domain_id	string
schedule_id	string
name	string
collect_mode	string
schedule	Scheduled
created_at	string
last_scheduled_at	string
collector_info	CollectorInfo
filter	google.protobuf.Struct

ScheduleQuery

Field	Type	Required	Description
query	spaceone.api.core.v1.Query	✘
collector_id	string	✔
schedule_id	string	✘
domain_id	string	✔

ScheduleRequest

Field	Type	Required	Description
domain_id	string	✔
schedule_id	string	✔
collector_id	string	✔

Scheduled

Field	Type	Description
cron	string
interval	int32
minutes	list of int32
hours	list of int32

SchedulesInfo

Field	Type	Description
results	list of ScheduleInfo
total_count	int32

UpdateCollectorRequest

Field	Type	Required	Description
collector_id	string	✔
name	string	✘
plugin_info	PluginInfo	✘
priority	int32	✘
tags	google.protobuf.Struct	✘
domain_id	string	✔

UpdatePluginRequest

Field	Type	Required	Description
collector_id	string	✔
version	string	✘
options	google.protobuf.Struct	✘
domain_id	string	✔
upgrade_mode	NONE MANUAL AUTO	✘

UpdateScheduleRequest

Field	Type	Required	Description
domain_id	string	✔
schedule_id	string	✔
collector_id	string	✔
name	string	✘
collect_mode	string	✘
schedule	Scheduled	✘
filter	google.protobuf.Struct	✘

VerifyInfo

Field	Type	Description
status	bool

VerifyPluginRequest

Field	Type	Required	Description
collector_id	string	✔
secret_id	string	✘
domain_id	string	✔