Job

A Job is an act of collecting external cloud resources through plugins.

Package : spaceone.api.inventory.v1

Job

Job Methods:

MethodRequestResponse

delete

JobRequest

Empty

get

JobRequest

JobInfo

list

JobsQuery

JobsInfo

analyze

JobAnalyzeQuery

Struct

stat

JobStatQuery

Struct

delete

Deletes a specific Job. You must specify the job_id of the Job to delete.

POST /inventory/v1/job/delete

{{< tabs " delete " >}}

{{< tab "Request Example" >}}

JobRequest

  • job_id (string) Required

{{< highlight json >}} { "job_id": "job-123456789012", } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

get

Gets a specific Job. Prints detailed information about the Job, including its state, total tasks, and collector info.

POST /inventory/v1/job/get

{{< tabs " get " >}}

{{< tab "Request Example" >}}

JobRequest

  • job_id (string) Required

{{< highlight json >}} { "job_id": "job-123456789012", } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

JobInfo

  • job_id (string) Required

  • status (Status) Required

  • total_tasks (int32) Required

  • remained_tasks (int32) Required

  • success_tasks (int32) Required

  • failure_tasks (int32) Required

  • request_secret_id (string) Required

  • request_workspace_id (string) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • collector_id (string) Required

  • plugin_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

  • finished_at (string) Required

{{< highlight json >}} { "job_id": "job-123456789012", "status": "ERROR", "filter": {}, "total_tasks": 2, "collector_info": { "collector_id": "collector-123456789012", "name": "Jenkins Collector", "state": "ENABLED", "plugin_info": { "plugin_id": "plugin-jenkins-inven-collector", "version": "0.1.1" }, "provider": "jenkins", "capability": {}, "is_public": true }, "domain_id": "domain-123456789012", "created_at": "2022-01-01T10:00:01.389Z", "updated_at": "2022-01-01T10:00:01.389Z", "finished_at": "2022-01-01T10:02:11.270Z" } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

list

Gets a list of all Jobs. You can use a query to get a filtered list of Jobs.

POST /inventory/v1/job/list

{{< tabs " list " >}}

{{< tab "Request Example" >}}

JobsQuery

  • query (Query)

  • job_id (string)

  • status (JobStatus)

  • workspace_id (string)

  • collector_id (string)

  • plugin_id (string)

{{< highlight json >}} { "query": {} } {{< /highlight >}} {{< /tab >}}

{{< tab "Response Example" >}}

JobsInfo

  • results (JobInfo) Repeated Required

  • total_count (int32) Required

{{< highlight json >}} { "results": [ { "job_id": "job-3b124006c2d2", "status": "SUCCESS", "filter": {}, "total_tasks": 2, "collector_info": { "collector_id": "collector-accd02663b3d", "name": "openstack-collector", "state": "ENABLED", "plugin_info": { "plugin_id": "plugin-openstack-inven-collector", "version": "0.4.2.20220616.134758" }, "provider": "openstack", "capability": { "supported_schema": [ "openstack_credentials" ] }, "is_public": true }, "resource_group": "DOMAIN", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-17T08:00:01.225Z", "updated_at": "2022-06-17T08:00:01.225Z", "finished_at": "2022-06-17T08:00:15.197Z" }, { "job_id": "job-587a3d3b4db3", "status": "SUCCESS", "filter": {}, "total_tasks": 3, "collector_info": { "collector_id": "collector-2c0847644f39", "name": "AWS stat-kwon Collector", "state": "ENABLED", "plugin_info": { "plugin_id": "plugin-30d21ef75a5d", "version": "1.13.13.20220610.143142" }, "provider": "aws", "capability": { "supported_schema": [ "aws_access_key" ] }, "is_public": true }, "resource_group": "DOMAIN", "domain_id": "domain-58010aa2e451", "created_at": "2022-06-17T08:00:00.407Z", "updated_at": "2022-06-17T08:00:00.407Z", "finished_at": "2022-06-17T08:07:32.023Z" } ], "total_count": 2 } {{< /highlight >}} {{< /tab >}}

{{< /tabs >}}

analyze

POST /inventory/v1/job/analyze

stat

POST /inventory/v1/job/stat

Message

JobAnalyzeQuery

  • query (AnalyzeQuery) Required

JobInfo

  • job_id (string) Required

  • status (Status) Required

  • total_tasks (int32) Required

  • remained_tasks (int32) Required

  • success_tasks (int32) Required

  • failure_tasks (int32) Required

  • request_secret_id (string) Required

  • request_workspace_id (string) Required

  • resource_group (ResourceGroup) Required

  • domain_id (string) Required

  • workspace_id (string) Required

  • collector_id (string) Required

  • plugin_id (string) Required

  • created_at (string) Required

  • updated_at (string) Required

  • finished_at (string) Required

JobRequest

  • job_id (string) Required

JobStatQuery

  • query (StatisticsQuery) Required

JobsInfo

  • results (JobInfo) Repeated Required

  • total_count (int32) Required

JobsQuery

  • query (Query)

  • job_id (string)

  • status (JobStatus)

  • workspace_id (string)

  • collector_id (string)

  • plugin_id (string)

PreviousCollectorRuleNextJobTask

Last updated