All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080
Method | HTTP request | Description |
---|---|---|
create_job_job | POST /platform/3/job/jobs | |
create_job_policy | POST /platform/1/job/policies | |
delete_job_policy | DELETE /platform/1/job/policies/{JobPolicyId} | |
get_job_events | GET /platform/3/job/events | |
get_job_job | GET /platform/3/job/jobs/{JobJobId} | |
get_job_job_summary | GET /platform/1/job/job-summary | |
get_job_policy | GET /platform/1/job/policies/{JobPolicyId} | |
get_job_recent | GET /platform/3/job/recent | |
get_job_reports | GET /platform/3/job/reports | |
get_job_statistics | GET /platform/1/job/statistics | |
get_job_type | GET /platform/1/job/types/{JobTypeId} | |
get_job_types | GET /platform/1/job/types | |
list_job_jobs | GET /platform/3/job/jobs | |
list_job_policies | GET /platform/1/job/policies | |
update_job_job | PUT /platform/3/job/jobs/{JobJobId} | |
update_job_policy | PUT /platform/1/job/policies/{JobPolicyId} | |
update_job_type | PUT /platform/1/job/types/{JobTypeId} |
CreateJobJobResponse create_job_job(job_job)
Queue a new instance of a job type.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_job = isi_sdk_8_0.JobJobCreateParams() # JobJobCreateParams |
try:
api_response = api_instance.create_job_job(job_job)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->create_job_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_job | JobJobCreateParams |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreateResponse create_job_policy(job_policy)
Create a new job impact policy.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_policy = isi_sdk_8_0.JobPolicyCreateParams() # JobPolicyCreateParams |
try:
api_response = api_instance.create_job_policy(job_policy)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->create_job_policy: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_policy | JobPolicyCreateParams |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_job_policy(job_policy_id)
Delete a job impact policy. System policies may not be deleted.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_policy_id = 'job_policy_id_example' # str | Delete a job impact policy. System policies may not be deleted.
try:
api_instance.delete_job_policy(job_policy_id)
except ApiException as e:
print("Exception when calling JobApi->delete_job_policy: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_policy_id | str | Delete a job impact policy. System policies may not be deleted. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobEvents get_job_events(begin=begin, end=end, job_id=job_id, resume=resume, job_type=job_type, timeout_ms=timeout_ms, state=state, limit=limit, key=key)
List job events.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
begin = 56 # int | Restrict the query to events at or after the given time, in seconds since the Epoch. (optional)
end = 56 # int | Restrict the query to events before the given time, in seconds since the Epoch. (optional)
job_id = 56 # int | Restrict the query to the given job ID. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)
job_type = 'job_type_example' # str | Restrict the query to the given job type. (optional)
timeout_ms = 56 # int | Query timeout in milliseconds. The default is 10000 ms. (optional)
state = 'state_example' # str | Restrict the query to events containing the given state. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
key = 'key_example' # str | Restrict the query to the given key name. (optional)
try:
api_response = api_instance.get_job_events(begin=begin, end=end, job_id=job_id, resume=resume, job_type=job_type, timeout_ms=timeout_ms, state=state, limit=limit, key=key)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_events: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
begin | int | Restrict the query to events at or after the given time, in seconds since the Epoch. | [optional] |
end | int | Restrict the query to events before the given time, in seconds since the Epoch. | [optional] |
job_id | int | Restrict the query to the given job ID. | [optional] |
resume | str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). | [optional] |
job_type | str | Restrict the query to the given job type. | [optional] |
timeout_ms | int | Query timeout in milliseconds. The default is 10000 ms. | [optional] |
state | str | Restrict the query to events containing the given state. | [optional] |
limit | int | Return no more than this many results at once (see resume). | [optional] |
key | str | Restrict the query to the given key name. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobJobs get_job_job(job_job_id)
View a single job instance.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_job_id = 'job_job_id_example' # str | View a single job instance.
try:
api_response = api_instance.get_job_job(job_job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_job_id | str | View a single job instance. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobJobSummary get_job_job_summary()
View job engine status.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
try:
api_response = api_instance.get_job_job_summary()
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_job_summary: %s\n" % e)
This endpoint does not need any parameter.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobPolicies get_job_policy(job_policy_id)
View a single job impact policy.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_policy_id = 'job_policy_id_example' # str | View a single job impact policy.
try:
api_response = api_instance.get_job_policy(job_policy_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_policy: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_policy_id | str | View a single job impact policy. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobRecent get_job_recent(timeout_ms=timeout_ms, limit=limit)
List recently completed jobs.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
timeout_ms = 56 # int | Query timeout in milliseconds. The default is 10000 ms. (optional)
limit = 56 # int | Max number of recent jobs to return. The default is 8, the max is 100. (optional)
try:
api_response = api_instance.get_job_recent(timeout_ms=timeout_ms, limit=limit)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_recent: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
timeout_ms | int | Query timeout in milliseconds. The default is 10000 ms. | [optional] |
limit | int | Max number of recent jobs to return. The default is 8, the max is 100. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobReports get_job_reports(begin=begin, end=end, job_id=job_id, resume=resume, job_type=job_type, timeout_ms=timeout_ms, limit=limit, key=key, verbose=verbose)
List job reports.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
begin = 56 # int | Restrict the query to reports at or after the given time, in seconds since the Epoch. (optional)
end = 56 # int | Restrict the query to reports before the given time, in seconds since the Epoch. (optional)
job_id = 56 # int | Restrict the query to the given job ID. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)
job_type = 'job_type_example' # str | Restrict the query to the given job type. (optional)
timeout_ms = 56 # int | Query timeout in milliseconds. The default is 10000 ms. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
key = 'key_example' # str | Restrict the query to the given report key. (optional)
verbose = true # bool | Display more detailed information, including job engine framework statistics. (optional)
try:
api_response = api_instance.get_job_reports(begin=begin, end=end, job_id=job_id, resume=resume, job_type=job_type, timeout_ms=timeout_ms, limit=limit, key=key, verbose=verbose)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_reports: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
begin | int | Restrict the query to reports at or after the given time, in seconds since the Epoch. | [optional] |
end | int | Restrict the query to reports before the given time, in seconds since the Epoch. | [optional] |
job_id | int | Restrict the query to the given job ID. | [optional] |
resume | str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). | [optional] |
job_type | str | Restrict the query to the given job type. | [optional] |
timeout_ms | int | Query timeout in milliseconds. The default is 10000 ms. | [optional] |
limit | int | Return no more than this many results at once (see resume). | [optional] |
key | str | Restrict the query to the given report key. | [optional] |
verbose | bool | Display more detailed information, including job engine framework statistics. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobStatistics get_job_statistics()
View job engine statistics.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
try:
api_response = api_instance.get_job_statistics()
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_statistics: %s\n" % e)
This endpoint does not need any parameter.
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobTypes get_job_type(job_type_id)
Retrieve job type information.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_type_id = 'job_type_id_example' # str | Retrieve job type information.
try:
api_response = api_instance.get_job_type(job_type_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_type: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_type_id | str | Retrieve job type information. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobTypesExtended get_job_types(sort=sort, show_all=show_all, dir=dir)
List job types.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | The field that will be used for sorting. (optional)
show_all = true # bool | Whether to show all job types, including hidden ones. Defaults to false. (optional)
dir = 'dir_example' # str | The direction of the sort. (optional)
try:
api_response = api_instance.get_job_types(sort=sort, show_all=show_all, dir=dir)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->get_job_types: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
sort | str | The field that will be used for sorting. | [optional] |
show_all | bool | Whether to show all job types, including hidden ones. Defaults to false. | [optional] |
dir | str | The direction of the sort. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobJobsExtended list_job_jobs(sort=sort, resume=resume, batch=batch, state=state, limit=limit, dir=dir)
List running and paused jobs.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | The field that will be used for sorting. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)
batch = true # bool | If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible. (optional)
state = 'state_example' # str | Limit the results to jobs in the specified state. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
dir = 'dir_example' # str | The direction of the sort. (optional)
try:
api_response = api_instance.list_job_jobs(sort=sort, resume=resume, batch=batch, state=state, limit=limit, dir=dir)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->list_job_jobs: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
sort | str | The field that will be used for sorting. | [optional] |
resume | str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). | [optional] |
batch | bool | If true, other arguments are ignored, and the query will return all results, unsorted, as quickly as possible. | [optional] |
state | str | Limit the results to jobs in the specified state. | [optional] |
limit | int | Return no more than this many results at once (see resume). | [optional] |
dir | str | The direction of the sort. | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
JobPoliciesExtended list_job_policies(sort=sort, limit=limit, dir=dir, resume=resume)
List job impact policies.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
sort = 'sort_example' # str | The field that will be used for sorting. (optional)
limit = 56 # int | Return no more than this many results at once (see resume). (optional)
dir = 'dir_example' # str | The direction of the sort. (optional)
resume = 'resume_example' # str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). (optional)
try:
api_response = api_instance.list_job_policies(sort=sort, limit=limit, dir=dir, resume=resume)
pprint(api_response)
except ApiException as e:
print("Exception when calling JobApi->list_job_policies: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
sort | str | The field that will be used for sorting. | [optional] |
limit | int | Return no more than this many results at once (see resume). | [optional] |
dir | str | The direction of the sort. | [optional] |
resume | str | Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options). | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_job_job(job_job, job_job_id)
Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_job = isi_sdk_8_0.JobJob() # JobJob |
job_job_id = 'job_job_id_example' # str | Modify a running or paused job instance. All input fields are optional, but one or more must be supplied.
try:
api_instance.update_job_job(job_job, job_job_id)
except ApiException as e:
print("Exception when calling JobApi->update_job_job: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_job | JobJob | ||
job_job_id | str | Modify a running or paused job instance. All input fields are optional, but one or more must be supplied. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_job_policy(job_policy, job_policy_id)
Modify a job impact policy.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_policy = isi_sdk_8_0.JobPolicy() # JobPolicy |
job_policy_id = 'job_policy_id_example' # str | Modify a job impact policy.
try:
api_instance.update_job_policy(job_policy, job_policy_id)
except ApiException as e:
print("Exception when calling JobApi->update_job_policy: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_policy | JobPolicy | ||
job_policy_id | str | Modify a job impact policy. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_job_type(job_type, job_type_id)
Modify the job type. All input fields are optional, but one or more must be supplied.
from __future__ import print_function
import time
import isi_sdk_8_0
from isi_sdk_8_0.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: basicAuth
configuration = isi_sdk_8_0.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = isi_sdk_8_0.JobApi(isi_sdk_8_0.ApiClient(configuration))
job_type = isi_sdk_8_0.JobType() # JobType |
job_type_id = 'job_type_id_example' # str | Modify the job type. All input fields are optional, but one or more must be supplied.
try:
api_instance.update_job_type(job_type, job_type_id)
except ApiException as e:
print("Exception when calling JobApi->update_job_type: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
job_type | JobType | ||
job_type_id | str | Modify the job type. All input fields are optional, but one or more must be supplied. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]