Skip to content

SyntheticCatalogApi.md

Latest commit

 

History

History
167 lines (113 loc) · 5.24 KB

SyntheticCatalogApi.md

File metadata and controls

167 lines (113 loc) · 5.24 KB

instana_client.SyntheticCatalogApi

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

Method HTTP request Description
get_synthetic_catalog_metrics GET /api/synthetics/catalog/metrics Get Metric catalog
get_synthetic_tag_catalog GET /api/synthetics/catalog Get synthetic tag catalog

get_synthetic_catalog_metrics

List[MetricDescription] get_synthetic_catalog_metrics()

Get Metric catalog

API to get catalog of synthetic metrics.

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.metric_description import MetricDescription
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.SyntheticCatalogApi(api_client)

    try:
        # Get Metric catalog
        api_response = api_instance.get_synthetic_catalog_metrics()
        print("The response of SyntheticCatalogApi->get_synthetic_catalog_metrics:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticCatalogApi->get_synthetic_catalog_metrics: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[MetricDescription]

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
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_synthetic_tag_catalog

TagCatalog get_synthetic_tag_catalog(use_case)

Get synthetic tag catalog

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.SyntheticCatalogApi(api_client)
    use_case = 'use_case_example' # str | 

    try:
        # Get synthetic tag catalog
        api_response = api_instance.get_synthetic_tag_catalog(use_case)
        print("The response of SyntheticCatalogApi->get_synthetic_tag_catalog:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SyntheticCatalogApi->get_synthetic_tag_catalog: %s\n" % e)

Parameters

Name Type Description Notes
use_case str

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 Bad request. -
401 Unauthorized access - requires user authentication. -
500 Internal server error. -

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