콘텐츠로 이동

조회



GET /api/v1/slo/{slo_uuid}/get

개요

UUID로 SLO의 구성, 연결된 모니터 및 알림 정책을 조회합니다.

호출 전 및 사용 단계

먼저 SLO 목록을 호출하고, content.data[].uuid에서 SLO 식별자를 선택합니다. 요청은 동일한 워크스페이스의 API Key를 사용합니다. 일일 가용률을 조회해야 하는 경우 config.sliType이 monitor인지 확인합니다.

경로 파라미터

파라미터명 유형 필수 설명
slo_uuid string Y 대상 SLO UUID.
예: monitor_example
가져오기 또는 입력 방법: SLO 목록 응답의 content.data[].uuid에서 가져옵니다.

요청 헤더

파라미터명 유형 필수 설명
DF-API-KEY string Y 현재 워크스페이스의 OpenAPI Key.
예: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 호출 자격 증명을 가져옵니다.

파라미터 추가 설명

현재 API Key가 속한 워크스페이스 내에서 SLO를 조회합니다.

요청 예시

curl --get -H "DF-API-KEY: <DF-API-KEY>" \
  'https://openapi.guance.com/api/v1/slo/monitor_example/get'

응답

HTTP 200, application/json.

필드 유형 설명
content.uuid string SLO UUID. SLO 조회, 가용률 및 실행 상태 조회에 사용됩니다.
content.workspaceUUID string 소속 워크스페이스.
content.name string SLO 이름.
content.id integer 레코드 ID.
content.type string 고정 값은 slo입니다.
content.score number SLO 레코드의 점수 필드입니다.
content.status integer 0은 활성화, 2는 비활성화를 나타냅니다.
content.creator string 생성자 식별자.
content.updator string 마지막 수정자 식별자.
content.createAt number 생성 시간, Unix 초.
content.updateAt number 마지막 수정 시간, Unix 초.
content.deleteAt number 삭제 시간, 삭제되지 않은 경우 일반적으로 -1입니다.
content.creatorInfo object 생성자 정보, 조회되지 않으면 {}입니다.
content.updatorInfo object 마지막 수정자 정보, 조회되지 않으면 {}입니다.
content.config object SLO 구성.
content.config.sliType string monitor는 모니터 유형, metric은 메트릭 유형을 나타냅니다. 기존 레코드에 설정이 없으면 monitor로 반환됩니다.
content.config.checkRange integer 통계 주기, 단위는 초입니다. 604800(7일) 및 2592000(30일)을 지원하며, 기본값은 604800으로 반환됩니다.
content.config.goal number 목표 가용률 백분율.
content.config.minGoal number 최저 가용률 목표 백분율.
content.config.describe string SLO 설명.
content.config.interval string 검사 빈도, 예: 5m 또는 10m.
content.config.groupBy array<string> 그룹화 필드.
content.config.ignoreBadGroupEvents boolean 비정상 그룹 이벤트 무시 여부.
content.config.sli_infos array<object> 연결된 모니터 목록, 연결되지 않은 경우 비어 있습니다.
content.config.sli_infos[].id string 연결된 모니터 UUID.
content.config.sli_infos[].name string 연결된 모니터 이름.
content.config.sli_infos[].status integer 연결된 모니터 상태.
content.config.metricQueries object 메트릭 유형에만 해당합니다. total과 good은 각각 전체량 및 성공량 쿼리 구성입니다. 키 아래에는 dql, queryType, editor가 포함되며, PromQL은 추가로 promqlType을 포함할 수 있습니다.
content.metricQueryInfo object 메트릭 유형에만 해당합니다. 수집 데이터를 선택하는 데 사용됩니다.
content.metricQueryInfo.measurement string 고정 값은 slo_metric입니다.
content.metricQueryInfo.sloId string 수집 데이터에 사용되는 식별자로, 이 API의 비즈니스 UUID 용도와 다릅니다.
content.metricQueryInfo.validAfter integer 또는 null 계산 유효 시작 시간, Unix 밀리초.
content.metricQueryInfo.stoppedAt integer 또는 null 수집 중지 시간, Unix 밀리초.
content.tagInfo array<object> 연결된 태그. 연결되지 않은 경우 빈 배열입니다.
content.tagInfo[].id integer 태그 레코드 ID.
content.tagInfo[].uuid string 태그 식별자.
content.tagInfo[].name string 태그 이름, 태그 조회에 사용됩니다.
content.tagInfo[].description string 태그 설명.
content.tagInfo[].colour string 태그 색상.
content.tagInfo[].scope string 태그 적용 범위.
content.alertPolicyInfos array<object> 연결된 알림 정책. 연결되지 않은 경우 빈 배열입니다.
content.alertPolicyInfos[].uuid string 알림 정책 UUID.
content.alertPolicyInfos[].name string 알림 정책 이름.
content.declaration object 또는 null 워크스페이스 선언.
{
  "code": 200,
  "content": {
    "id": 1,
    "uuid": "monitor_example",
    "workspaceUUID": "wksp_example",
    "name": "服务可用率",
    "type": "slo",
    "score": 0,
    "status": 0,
    "config": {
      "sliType": "monitor",
      "checkRange": 604800,
      "goal": 99.9,
      "minGoal": 99.5,
      "describe": "结账服务",
      "interval": "5m",
      "sli_infos": [
        {
          "id": "rul_example",
          "name": "结账检查",
          "status": 0
        }
      ]
    },
    "tagInfo": [],
    "alertPolicyInfos": [],
    "creatorInfo": {},
    "updatorInfo": {},
    "declaration": null,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785430800,
    "deleteAt": -1
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
404 ft.NotFoundSLO SLO가 존재하지 않거나, 삭제되었거나, 현재 워크스페이스에 속하지 않거나, 메트릭 유형 구성에 연결된 수집기가 없음 지정한 SLO를 찾을 수 없습니다. 현재 워크스페이스의 SLO 목록에서 실제 UUID를 가져오고, 모니터 구성이 유효한지 확인합니다.

문서 평가

이 페이지가 도움이 되었나요?