Skip to content

SLOCatalogForMobileAppApi.md

Latest commit

 

History

History
173 lines (118 loc) · 5.95 KB

SLOCatalogForMobileAppApi.md

File metadata and controls

173 lines (118 loc) · 5.95 KB
Raw

instana_client.SLOCatalogForMobileAppApi

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

Method HTTP request Description
get_mobile_app_sli_metric_catalog GET /api/slo/catalog/metrics/mobile Mobile app SLI metric catalog
get_mobile_app_slo_tag_catalog GET /api/slo/catalog/tags/mobile Get mobile app monitoring tag catalog for Mobile App SLOs

get_mobile_app_sli_metric_catalog

List[object] get_mobile_app_sli_metric_catalog(slo_blueprint=slo_blueprint, beacon_type=beacon_type)

Mobile app SLI metric catalog

API request to get mobile app SLI metric catalog filtered by golden signal and beacon type.

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.SLOCatalogForMobileAppApi(api_client)
    slo_blueprint = 'slo_blueprint_example' # str |  (optional)
    beacon_type = 'beacon_type_example' # str |  (optional)

    try:
        # Mobile app SLI metric catalog
        api_response = api_instance.get_mobile_app_sli_metric_catalog(slo_blueprint=slo_blueprint, beacon_type=beacon_type)
        print("The response of SLOCatalogForMobileAppApi->get_mobile_app_sli_metric_catalog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLOCatalogForMobileAppApi->get_mobile_app_sli_metric_catalog: %s\n" % e)

Parameters

Name Type Description Notes
slo_blueprint str [optional]
beacon_type str [optional]

Return type

List[object]

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 When the sloGoldenSignal/beaconType combination is unsupported. -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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

get_mobile_app_slo_tag_catalog

TagCatalog get_mobile_app_slo_tag_catalog(beacon_type=beacon_type)

Get mobile app monitoring tag catalog for Mobile App SLOs

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.tag_catalog import TagCatalog
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.SLOCatalogForMobileAppApi(api_client)
    beacon_type = 'beacon_type_example' # str |  (optional)

    try:
        # Get mobile app monitoring tag catalog for Mobile App SLOs
        api_response = api_instance.get_mobile_app_slo_tag_catalog(beacon_type=beacon_type)
        print("The response of SLOCatalogForMobileAppApi->get_mobile_app_slo_tag_catalog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SLOCatalogForMobileAppApi->get_mobile_app_slo_tag_catalog: %s\n" % e)

Parameters

Name Type Description Notes
beacon_type str [optional]

Return type

TagCatalog

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 When the beaconType unsupported/unknown. -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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