Job #
A Job is an act of collecting external cloud resources through plugins.
Package : spaceone.api.inventory_v2.v1
Job #
Job Methods:
| Method | Request | Response |
|---|---|---|
| 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-v2/v1/job/delete
get #
Gets a specific Job. Prints detailed information about the Job, including its state, total tasks, and collector info.
POST /inventory-v2/v1/job/get
job_id (string)
Requiredstatus (Status)
Requiredtotal_tasks (int32)
Requiredremained_tasks (int32)
Requiredsuccess_tasks (int32)
Requiredfailure_tasks (int32)
Requiredrequest_secret_id (string)
Requiredrequest_workspace_id (string)
Requiredresource_group (ResourceGroup)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcollector_id (string)
Requiredplugin_id (string)
Requiredcreated_at (string)
Requiredupdated_at (string)
Requiredfinished_at (string)
Required
{
"job_id": "job-123456789012",
"status": "SUCCESS",
"total_tasks": 2,
"success_tasks": 2,
"request_secret_id: "secret-123456789012",
"request_workspace_id": "workspace-123456789012",
"resource_group": "WORKSPACE"
"workspace_id": "workspace-123456789012",
"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"
}list #
Gets a list of all Jobs. You can use a query to get a filtered list of Jobs.
POST /inventory-v2/v1/job/list
query (Query)
job_id (string)
status (JobStatus)
workspace_id (string)
collector_id (string)
plugin_id (string)
{
"query": {
"page": {
"start": 1,
"limit": 5
}
}
}results (JobInfo)
RepeatedRequiredtotal_count (int32)
Required
{
"results": [
{
"job_id": "job-3b124006c2d2",
"status": "SUCCESS",
"total_tasks": 2,
"success_tasks": 2,
"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": "IN_PROGRESS",
"total_tasks": 3,
"success_tasks": 1,
"remained_tasks": 1.
"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"
},
{
"job_id": "job-587a3d3b4db3",
"status": "FAILURE",
"total_tasks": 3,
"success_tasks": 1,
"failure_tasks": 1,
"resource_group": "DOMAIN",
"domain_id": "domain-58010aa2e451",
"created_at": "2022-06-17T08:00:00.407Z",
"updated_at": "2022-06-17T08:05:00.407Z",
"finished_at": "2022-06-17T08:10:00.407Z"
}
],
"total_count": 3
}analyze #
POST /inventory-v2/v1/job/analyze
- query (AnalyzeQuery)
Required
{
"query": {
"group_by": ["job_id", "status"],
"page": {
"start": 1, "limit": 5
},
"fields": {
"total_tasks_sum": {
"key": "total_tasks",
"operator": "sum"
},
"remain_tasks_sum": {
"key": "remain_tasks",
"operator": "sum"
},
"failure_tasks_sum": {
"key": "failure_tasks",
"operator": "sum"
}
}
}
}stat #
POST /inventory-v2/v1/job/stat
Message #
JobAnalyzeQuery #
query (AnalyzeQuery)
Required
JobInfo #
job_id (string)
Requiredstatus (Status)
Requiredtotal_tasks (int32)
Requiredremained_tasks (int32)
Requiredsuccess_tasks (int32)
Requiredfailure_tasks (int32)
Requiredrequest_secret_id (string)
Requiredrequest_workspace_id (string)
Requiredresource_group (ResourceGroup)
Requireddomain_id (string)
Requiredworkspace_id (string)
Requiredcollector_id (string)
Requiredplugin_id (string)
Requiredcreated_at (string)
Requiredupdated_at (string)
Requiredfinished_at (string)
Required
JobRequest #
job_id (string)
Required
JobStatQuery #
query (StatisticsQuery)
Required
JobsInfo #
results (JobInfo)
RepeatedRequiredtotal_count (int32)
Required
JobsQuery #
query (Query)
job_id (string)
status (JobStatus)
workspace_id (string)
collector_id (string)
plugin_id (string)