instana_client.ServiceLevelsObjectiveSLOConfigurationsApi

All URIs are relative to https://unit-tenant.instana.io

Method	HTTP request	Description
create_slo_config	POST /api/settings/slo	Create a new SLO Config
delete_slo_config	DELETE /api/settings/slo/{id}	Delete an existing SLO Config
get_all_slo_config_tags	GET /api/settings/slo/tags	Get All SLO Config tags
get_all_slo_configs	GET /api/settings/slo	Get All SLO Configs
get_slo_config_by_id	GET /api/settings/slo/{id}	Get an existing SLO Config
update_slo_config	PUT /api/settings/slo/{id}	Update an existing SLO Config

create_slo_config

SLOConfigWithRBACTag create_slo_config(slo_config_with_rbac_tag)

Create a new SLO Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    slo_config_with_rbac_tag = {"name":"Stans test SLO 4","target":0.99,"rbacTags":[{"id":"R3_hPrHXSMe0yGsnlFdReA","displayName":"team 1"}],"entity":{"type":"application","applicationId":"VTNvC_sATZqMj4vSZfsjKA","serviceId":null,"endpointId":null,"boundaryScope":"INBOUND","includeInternal":false,"includeSynthetic":false,"tagFilterExpression":null},"indicator":{"type":"timeBased","blueprint":"latency","threshold":100,"aggregation":"P90"},"timeWindow":{"type":"rolling","duration":1,"durationUnit":"week"},"tags":["Stan","testing"]} # SLOConfigWithRBACTag | 

    try:
        # Create a new SLO Config
        api_response = api_instance.create_slo_config(slo_config_with_rbac_tag)
        print("The response of ServiceLevelsObjectiveSLOConfigurationsApi->create_slo_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->create_slo_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
slo_config_with_rbac_tag	SLOConfigWithRBACTag

Return type

SLOConfigWithRBACTag

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	New SLO Configuration Created Successfully	-
400	Invalid Tag Filter	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_slo_config

delete_slo_config(id)

Delete an existing SLO Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    id = 'SLOdCTspkHlS_OzNOATQWgsuw' # str | 

    try:
        # Delete an existing SLO Config
        api_instance.delete_slo_config(id)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->delete_slo_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str

Return type

void (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	SLO Configuration Deleted Successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_slo_config_tags

List[str] get_all_slo_config_tags(query=query, tag=tag, entity_type=entity_type)

Get All SLO Config tags

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    query = 'test SLO' # str |  (optional)
    tag = ['Testing'] # List[str] |  (optional)
    entity_type = 'application' # str |  (optional)

    try:
        # Get All SLO Config tags
        api_response = api_instance.get_all_slo_config_tags(query=query, tag=tag, entity_type=entity_type)
        print("The response of ServiceLevelsObjectiveSLOConfigurationsApi->get_all_slo_config_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->get_all_slo_config_tags: %s\n" % e)

Parameters

Name	Type	Notes
query	str	[optional]
tag	List[str]	[optional]
entity_type	str	[optional]

Return type

List[str]

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Fetched list of SLO Configuration tags Successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_slo_configs

PaginatedResult get_all_slo_configs(page_size=page_size, page=page, order_by=order_by, order_direction=order_direction, query=query, tag=tag, entity_type=entity_type, infra_entity_types=infra_entity_types, kubernetes_cluster_uuid=kubernetes_cluster_uuid, blueprint=blueprint, slo_ids=slo_ids, slo_status=slo_status, entity_ids=entity_ids, grouped=grouped, refresh=refresh, rbac_tags=rbac_tags)

Get All SLO Configs

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.paginated_result import PaginatedResult
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    page_size = 1 # int |  (optional)
    page = 1 # int |  (optional)
    order_by = 'name' # str |  (optional)
    order_direction = 'ASC' # str |  (optional)
    query = 'test SLO' # str |  (optional)
    tag = ['Testing'] # List[str] |  (optional)
    entity_type = ['application'] # List[str] |  (optional)
    infra_entity_types = ['KubernetesCluster'] # List[str] |  (optional)
    kubernetes_cluster_uuid = '823b8c2e-5bc3-11ee-a0f4-42010a8000ff' # str |  (optional)
    blueprint = ['latency'] # List[str] |  (optional)
    slo_ids = ['SLOdCTspkHlS_OzNOATQWgsuw'] # List[str] |  (optional)
    slo_status = 'green' # str |  (optional)
    entity_ids = ['adsewby312sdfd1'] # List[str] |  (optional)
    grouped = false # bool |  (optional)
    refresh = false # bool |  (optional)
    rbac_tags = ['Testing'] # List[str] |  (optional)

    try:
        # Get All SLO Configs
        api_response = api_instance.get_all_slo_configs(page_size=page_size, page=page, order_by=order_by, order_direction=order_direction, query=query, tag=tag, entity_type=entity_type, infra_entity_types=infra_entity_types, kubernetes_cluster_uuid=kubernetes_cluster_uuid, blueprint=blueprint, slo_ids=slo_ids, slo_status=slo_status, entity_ids=entity_ids, grouped=grouped, refresh=refresh, rbac_tags=rbac_tags)
        print("The response of ServiceLevelsObjectiveSLOConfigurationsApi->get_all_slo_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->get_all_slo_configs: %s\n" % e)

Parameters

Name	Type	Notes
page_size	int	[optional]
page	int	[optional]
order_by	str	[optional]
order_direction	str	[optional]
query	str	[optional]
tag	List[str]	[optional]
entity_type	List[str]	[optional]
infra_entity_types	List[str]	[optional]
kubernetes_cluster_uuid	str	[optional]
blueprint	List[str]	[optional]
slo_ids	List[str]	[optional]
slo_status	str	[optional]
entity_ids	List[str]	[optional]
grouped	bool	[optional]
refresh	bool	[optional]
rbac_tags	List[str]	[optional]

Return type

PaginatedResult

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Fetched list of the SLO Configurations Successfully	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_slo_config_by_id

SLOConfigWithRBACTag get_slo_config_by_id(id, refresh=refresh)

Get an existing SLO Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    id = 'SLOdCTspkHlS_OzNOATQWgsuw' # str | 
    refresh = false # bool |  (optional)

    try:
        # Get an existing SLO Config
        api_response = api_instance.get_slo_config_by_id(id, refresh=refresh)
        print("The response of ServiceLevelsObjectiveSLOConfigurationsApi->get_slo_config_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->get_slo_config_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
refresh	bool		[optional]

Return type

SLOConfigWithRBACTag

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Fetched SLO Configuration Successfully	-
404	SLO Configuration Not Found	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_slo_config

SLOConfigWithRBACTag update_slo_config(id, slo_config_with_rbac_tag)

Update an existing SLO Config

Example

Api Key Authentication (ApiKeyAuth):

import instana_client
from instana_client.models.slo_config_with_rbac_tag import SLOConfigWithRBACTag
from instana_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://unit-tenant.instana.io
# See configuration.py for a list of all supported configuration parameters.
configuration = instana_client.Configuration(
    host = "https://unit-tenant.instana.io"
)

# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with instana_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = instana_client.ServiceLevelsObjectiveSLOConfigurationsApi(api_client)
    id = 'SLOdCTspkHlS_OzNOATQWgsuw' # str | 
    slo_config_with_rbac_tag = {"name":"Stans test SLO 4","target":0.99,"rbacTags":[{"id":"R3_hPrHXSMe0yGsnlFdReA","displayName":"team 1"}],"entity":{"type":"application","applicationId":"VTNvC_sATZqMj4vSZfsjKA","serviceId":null,"endpointId":null,"boundaryScope":"INBOUND","includeInternal":false,"includeSynthetic":false,"tagFilterExpression":null},"indicator":{"type":"timeBased","blueprint":"latency","threshold":100,"aggregation":"P90"},"timeWindow":{"type":"rolling","duration":1,"durationUnit":"week"},"tags":["Stan","testing"]} # SLOConfigWithRBACTag | 

    try:
        # Update an existing SLO Config
        api_response = api_instance.update_slo_config(id, slo_config_with_rbac_tag)
        print("The response of ServiceLevelsObjectiveSLOConfigurationsApi->update_slo_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOConfigurationsApi->update_slo_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str
slo_config_with_rbac_tag	SLOConfigWithRBACTag

Return type

SLOConfigWithRBACTag

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Updated SLO Configuration Successfully	-
400	Bad Request	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

ServiceLevelsObjectiveSLOConfigurationsApi.md

Latest commit

History

ServiceLevelsObjectiveSLOConfigurationsApi.md

File metadata and controls

instana_client.ServiceLevelsObjectiveSLOConfigurationsApi

create_slo_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_slo_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_slo_config_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_all_slo_configs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_slo_config_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_slo_config

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details