Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 4.08 KB

ServiceLevelsObjectiveSLOReportApi.md

File metadata and controls

95 lines (66 loc) · 4.08 KB

instana_client.ServiceLevelsObjectiveSLOReportApi

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

Method HTTP request Description
get_slo GET /api/slo/report/{sloId} Generate Service Levels report

get_slo

List[SloReport] get_slo(slo_id, var_from=var_from, to=to, exclude_correction_id=exclude_correction_id, include_correction_id=include_correction_id)

Generate Service Levels report

Example

  • Api Key Authentication (ApiKeyAuth):
import instana_client
from instana_client.models.slo_report import SloReport
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.ServiceLevelsObjectiveSLOReportApi(api_client)
    slo_id = 'SLOEANnWh9tQOa2h88kGxK6wQ' # str | Service Levels Objective(SLO) Configuration ID
    var_from = '1706713140000' # str | Starting point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds (optional)
    to = '1706813100000' # str | Ending point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds (optional)
    exclude_correction_id = ['N1Xj6q8QTZu_cfJOGqy4mg'] # List[str] | IDs of Correction Configurations to be Excluded from the result (optional)
    include_correction_id = ['uvP7Z03pSUuybDT8-WHLDA'] # List[str] | IDs of Correction Configurations to be Included in the result (optional)

    try:
        # Generate Service Levels report
        api_response = api_instance.get_slo(slo_id, var_from=var_from, to=to, exclude_correction_id=exclude_correction_id, include_correction_id=include_correction_id)
        print("The response of ServiceLevelsObjectiveSLOReportApi->get_slo:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ServiceLevelsObjectiveSLOReportApi->get_slo: %s\n" % e)

Parameters

Name Type Description Notes
slo_id str Service Levels Objective(SLO) Configuration ID
var_from str Starting point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds [optional]
to str Ending point for the data retrieval, specified as 13 digit Unix Timestamp milliseconds [optional]
exclude_correction_id List[str] IDs of Correction Configurations to be Excluded from the result [optional]
include_correction_id List[str] IDs of Correction Configurations to be Included in the result [optional]

Return type

List[SloReport]

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Fetched SLO Configuration Report Successfully -
404 There is no SLO configuration for the given ID or the report hasn't been generated yet. -

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