--- title: SLO 상태 가져오기 description: 지정된 기간에 대한 SLO(Service Level Objective)의 상태를 가져옵니다. 이 엔드포인트는 지정된 SLO에 대한 현재 SLI 값, 남은 오류 예산 및 기타 상태 정보를 반환합니다. breadcrumbs: 문서 > API > SLO 상태 가져오기 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # SLO 상태 가져오기 ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint is in public beta and it's subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help.md). {% /alert %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------ | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/slo/{slo_id}/status | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/slo/{slo_id}/status | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/slo/{slo_id}/status | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/slo/{slo_id}/status | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/slo/{slo_id}/status | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/slo/{slo_id}/status | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/slo/{slo_id}/status | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/slo/{slo_id}/status | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/slo/{slo_id}/status | ### Overview 지정된 기간에 대한 SLO(Service Level Objective)의 상태를 가져옵니다. 이 엔드포인트는 지정된 SLO에 대한 현재 SLI 값, 남은 오류 예산 및 기타 상태 정보를 반환합니다. This endpoint requires the `slos_read` permission. OAuth apps require the `slos_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ko/api/latest/scopes.md#service-level-objectives) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | ------------------- | ------ | ------------------ | | slo_id [*required*] | string | The ID of the SLO. | #### Query Strings | Field | Type | Description | | -------------------- | ------- | ----------------------------------------------------------------------------------------------------------- | | from_ts [*required*] | integer | The starting timestamp for the SLO status query in epoch seconds. | | to_ts [*required*] | integer | The ending timestamp for the SLO status query in epoch seconds. | | disable_corrections | boolean | Whether to exclude correction windows from the SLO status calculation. Defaults to false. Default: `false`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} The SLO status response. | Parent field | Field | Type | Description | | -------------------------- | --------------------------------------- | ------ | ------------------------------------------------------------------------ | | | data [*required*] | object | The data portion of the SLO status response. | | data | attributes [*required*] | object | The attributes of the SLO status. | | attributes | error_budget_remaining [*required*] | double | The percentage of error budget remaining. | | attributes | raw_error_budget_remaining [*required*] | object | The raw error budget remaining for the SLO. | | raw_error_budget_remaining | unit [*required*] | string | The unit of the error budget (for example, `seconds`, `requests`). | | raw_error_budget_remaining | value [*required*] | double | The numeric value of the remaining error budget. | | attributes | sli [*required*] | double | The current Service Level Indicator (SLI) value as a percentage. | | attributes | span_precision [*required*] | int64 | The precision of the time span in seconds. | | attributes | state [*required*] | string | The current state of the SLO (for example, `breached`, `warning`, `ok`). | | data | id [*required*] | string | The ID of the SLO. | | data | type [*required*] | enum | The type of the SLO status resource. Allowed enum values: `slo_status`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "error_budget_remaining": 99.5, "raw_error_budget_remaining": { "unit": "seconds", "value": 86400.5 }, "sli": 99.95, "span_precision": 2, "state": "ok" }, "id": "00000000-0000-0000-0000-000000000000", "type": "slo_status" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------- | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export slo_id="00000000-0000-0000-0000-000000000000" # Required query arguments export from_ts="1690901870" export to_ts="1706803070" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/slo/${slo_id}/status?from_ts=${from_ts}&to_ts=${to_ts}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get SLO status returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetSloStatus", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewServiceLevelObjectivesApi(apiClient) resp, r, err := api.GetSloStatus(ctx, "00000000-0000-0000-0000-000000000000", 1690901870, 1706803070, *datadogV2.NewGetSloStatusOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ServiceLevelObjectivesApi.GetSloStatus`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ServiceLevelObjectivesApi.GetSloStatus`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get SLO status returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ServiceLevelObjectivesApi; import com.datadog.api.client.v2.model.SloStatusResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); defaultClient.setUnstableOperationEnabled("v2.getSloStatus", true); ServiceLevelObjectivesApi apiInstance = new ServiceLevelObjectivesApi(defaultClient); try { SloStatusResponse result = apiInstance.getSloStatus( "00000000-0000-0000-0000-000000000000", 1690901870L, 1706803070L); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ServiceLevelObjectivesApi#getSloStatus"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get SLO status returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.service_level_objectives_api import ServiceLevelObjectivesApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] configuration.unstable_operations["get_slo_status"] = True with ApiClient(configuration) as api_client: api_instance = ServiceLevelObjectivesApi(api_client) response = api_instance.get_slo_status( slo_id="00000000-0000-0000-0000-000000000000", from_ts=1690901870, to_ts=1706803070, ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get SLO status returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] config.unstable_operations["v2.get_slo_status".to_sym] = true end api_instance = DatadogAPIClient::V2::ServiceLevelObjectivesAPI.new p api_instance.get_slo_status("00000000-0000-0000-0000-000000000000", 1690901870, 1706803070) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get SLO status returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_service_level_objectives::GetSloStatusOptionalParams; use datadog_api_client::datadogV2::api_service_level_objectives::ServiceLevelObjectivesAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.get_slo_status", true); let api = ServiceLevelObjectivesAPI::with_config(configuration); let resp = api .get_slo_status( "00000000-0000-0000-0000-000000000000".to_string(), 1690901870, 1706803070, GetSloStatusOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get SLO status returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); configuration.unstableOperations["v2.getSloStatus"] = true; const apiInstance = new v2.ServiceLevelObjectivesApi(configuration); const params: v2.ServiceLevelObjectivesApiGetSloStatusRequest = { sloId: "00000000-0000-0000-0000-000000000000", fromTs: 1690901870, toTs: 1706803070, }; apiInstance .getSloStatus(params) .then((data: v2.SloStatusResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}