Collector

Package : spaceone.api.inventory.v1

Collector

Collector Methods:

create

POST /inventory/v1/collectors

Type

Message

Request

Response

update

PUT /inventory/v1/collector/{collector_id}

Type

Message

Request

Response

update_plugin

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

Type

Message

Request

Response

verify_plugin

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

delete

DELETE /inventory/v1/collector/{collector_id}

Type

Message

Request

Response

get

GET /inventory/v1/collector/{collector_id}

Type

Message

Request

Response

enable

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

Type

Message

Request

Response

disable

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

Type

Message

Request

Response

list

GET /inventory/v1/collectors

POST /inventory/v1/collectors/search

Type

Message

Request

Response

stat

POST /inventory/v1/collectors/stat

collect

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

Type

Message

Request

Response

add_schedule

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

Type

Message

Request

Response

get_schedule

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

Type

Message

Request

Response

update_schedule

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

Type

Message

Request

Response

delete_schedule

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

list_schedules

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

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

Type

Message

Request

Response

Message

CollectRequest

No

Field

Type

Required

Description

1

collector_id

string

2

filter

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

5

priority

6

tags

7

created_at

8

last_collected_at

9

domain_id

string

10

provider

string

11

capability

12

is_public

bool

13

project_id

string

CollectorQuery

No

Field

Type

Description

1

query

2

collector_id

string

3

name

string

4

state

  • NONE

  • ENABLED

  • DISABLED

5

priority

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

2

domain_id

string

CollectorsInfo

No

Field

Type

Description

1

results

2

total_count

CreateCollectorRequest

No

Field

Type

Required

Description

1

name

string

2

plugin_info

3

priority

4

tags

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

6

filter

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

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

4

total_tasks

5

remained_tasks

6

errors

7

collector_info

8

project_id

string

9

domain_id

string

10

created_at

11

updated_at

12

finished_at

PluginInfo

No

Field

Type

Description

1

plugin_id

string

2

version

string

3

options

4

secret_id

string

5

secret_group_id

string

6

provider

string

7

service_account_id

string

8

metadata

ScheduleInfo

No

Field

Type

Description

1

domain_id

string

2

schedule_id

string

3

name

string

4

collect_mode

string

5

schedule

6

created_at

7

last_scheduled_at

8

collector_info

9

filter

ScheduleQuery

No

Field

Type

Required

Description

1

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

3

minutes

4

hours

SchedulesInfo

No

Field

Type

Description

1

results

2

total_count

UpdateCollectorRequest

No

Field

Type

Required

Description

1

collector_id

string

2

name

string

3

plugin_info

4

priority

5

tags

6

domain_id

string

UpdatePluginRequest

No

Field

Type

Required

Description

1

collector_id

string

2

version

string

3

options

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

7

filter

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

Last updated