All URIs are relative to http://localhost:8081
Method | HTTP request | Description |
---|---|---|
cancel_operation | POST /operations/{operationId}/:cancel | Cancel Long-Running Operation (LRO) |
delete_operation | DELETE /operations/{operationId} | Delete Long-Running Operation (LRO) |
get_operation | GET /operations/{operationId} | Get Long-Running Operation (LRO) status and result |
cancel_operation(operation_id)
Cancel Long-Running Operation (LRO)
When the cancelable is true in operation metadata the clients are allowed to send a cancel request to ask the backend to cancel the operation. The server makes its best effort to cancel the operation, but success is not guaranteed.
- Bearer (JWT) Authentication (Bearer):
from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
host = "http://localhost:8081"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = extremecloudiq.OperationApi(api_client)
operation_id = 'operation_id_example' # str | The operation ID
try:
# Cancel Long-Running Operation (LRO)
api_instance.cancel_operation(operation_id)
except ApiException as e:
print("Exception when calling OperationApi->cancel_operation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
operation_id | str | The operation ID |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
401 | Unauthorized | - |
400 | Bad Request | - |
500 | Internal Server Error | - |
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_operation(operation_id)
Delete Long-Running Operation (LRO)
The Long-Running Operation (LRO) can be deleted when the operation is done or in PENDING status.
- Bearer (JWT) Authentication (Bearer):
from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
host = "http://localhost:8081"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = extremecloudiq.OperationApi(api_client)
operation_id = 'operation_id_example' # str | The operation ID
try:
# Delete Long-Running Operation (LRO)
api_instance.delete_operation(operation_id)
except ApiException as e:
print("Exception when calling OperationApi->delete_operation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
operation_id | str | The operation ID |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
401 | Unauthorized | - |
400 | Bad Request | - |
500 | Internal Server Error | - |
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
XiqOperationObject get_operation(operation_id)
Get Long-Running Operation (LRO) status and result
Get the Long-Running Operation (LRO) status and result. The response will include either result or error if the operation is done.
- Bearer (JWT) Authentication (Bearer):
from __future__ import print_function
import time
import extremecloudiq
from extremecloudiq.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8081
# See configuration.py for a list of all supported configuration parameters.
configuration = extremecloudiq.Configuration(
host = "http://localhost:8081"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): Bearer
configuration = extremecloudiq.Configuration(
access_token = 'YOUR_BEARER_TOKEN'
)
# Enter a context with an instance of the API client
with extremecloudiq.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = extremecloudiq.OperationApi(api_client)
operation_id = 'operation_id_example' # str | The operation ID
try:
# Get Long-Running Operation (LRO) status and result
api_response = api_instance.get_operation(operation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OperationApi->get_operation: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
operation_id | str | The operation ID |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
401 | Unauthorized | - |
400 | Bad Request | - |
500 | Internal Server Error | - |
200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]