콘텐츠로 이동

일별 가용성 일괄 조회



POST /api/v1/slo/availability/list

개요

현재 워크스페이스 내 모니터 유형 SLO의 일별 가용성을 일괄 조회하며, 초 단위 윈도우 집계를 함께 포함할 수 있습니다.

호출 전 및 사용 단계

  1. SLO 목록을 호출하여 모니터 유형 SLO를 필터링하고, 결과의 content.data[].uuid를 사용합니다. UUID 하나라도 사용할 수 없으면 전체 요청이 실패합니다.

  2. 보고서 요구 사항에 따라 비즈니스 날짜와 IANA 시간대를 선택합니다. 시작일과 종료일 모두 결과에 포함되며, 각 날짜는 해당 자연일의 실제 초 수를 기준으로 계산됩니다.

  3. 특정 기간을 조회해야 하는 경우 선택한 날짜 범위 내에 있는 window를 입력합니다. 윈도우 값과 일별 points는 각각 계산됩니다. 일별 샘플이 없으면 points의 해당 값은 비어 있습니다. 윈도우는 성공했지만 비용 샘플이 없으면 value는 100, hasData는 true, updatedAt은 null입니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 유형 필수 설명
window object 시작 포함, 종료 미포함, 최대 604800초입니다.
예시: {"startTime": 1785427200, "endTime": 1785430800}
가져오기 또는 입력 방법: 초 단위 집계가 반드시 필요한 경우에만 입력하고, 그렇지 않으면 객체 전체를 생략합니다.
window.startTime integer 조건부 필수 startDate의 자연일 시작보다 이르면 안 됩니다.
예시: 1785427200
가져오기 또는 입력 방법: 비즈니스 윈도우 시작 시간을 Unix 초로 변환합니다.
window.endTime integer 조건부 필수 시작 시간보다 늦어야 하며, 서버 현재 시간보다 늦으면 안 되고 endDate 자연일 종료를 초과해서도 안 됩니다.
예시: 1785430800
가져오기 또는 입력 방법: 윈도우 종료 시간을 Unix 초로 변환합니다.
sloUUIDs array Y 최대 100개의 SLO UUID이며, 결과는 중복 제거 후 요청 순서를 따릅니다.
null 허용: False
예시: ["monitor_example"]
가져오기 또는 입력 방법: SLO 목록 응답의 content.data[].uuid에서 가져오며, 모니터 유형을 선택합니다.
startDate string Y 시작일 포함.
null 허용: False
예시: 2026-07-31
가져오기 또는 입력 방법: 요청 시간대 기준으로 보고서 시작 날짜를 선택하며, 형식은 YYYY-MM-DD입니다.
endDate string Y 종료일 포함. 날짜 범위는 최대 90 자연일입니다.
null 허용: False
예시: 2026-07-31
가져오기 또는 입력 방법: 동일한 시간대 기준으로 보고서 종료 날짜를 선택하며, 형식은 YYYY-MM-DD입니다.
timezone string Y 통계에 사용되는 자연일 경계를 결정합니다.
null 허용: False
예시: Asia/Shanghai
가져오기 또는 입력 방법: 비즈니스 날짜가 속한 IANA 시간대를 입력합니다. 워크스페이스 상세의 content.timezone에서 참고 값을 가져올 수 있습니다.
interval string 일 단위 집계, 기본값 1d.
null 허용: False
선택 가능한 값: ['1d']
예시: 1d
가져오기 또는 입력 방법: 1d를 입력하거나 생략합니다.

파라미터 추가 설명

결과에는 일별 가용성 및 해당 등급이 포함되며, 정확한 시간 기준으로도 집계할 수 있습니다. 두 가지 통계 기준은 호출 안내를 참고하십시오.

요청 예시

curl 'https://openapi.guance.com/api/v1/slo/availability/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"sloUUIDs":["monitor_example"],"startDate":"2026-07-31","endDate":"2026-07-31","timezone":"Asia/Shanghai","window":{"startTime":1785427200,"endTime":1785430800}}'

응답

HTTP 200, application/json.

필드 유형 설명
content.data array<object> 중복 제거 후 요청 순서대로 반환된 SLO 통계입니다.
content.data[].sloUUID string SLO UUID.
content.data[].name string SLO 이름.
content.data[].status integer 0 활성, 2 비활성.
content.data[].goal number 목표 가용성(%).
content.data[].minGoal number 최소 가용성 목표(%).
content.data[].tagInfo array<object> 연결된 태그입니다. 연결되지 않은 경우 빈 배열입니다.
content.data[].tagInfo[].id integer 태그 레코드 ID.
content.data[].tagInfo[].uuid string 태그 식별자.
content.data[].tagInfo[].name string 태그 이름, 태그 조회에 사용됩니다.
content.data[].tagInfo[].description string 태그 설명.
content.data[].tagInfo[].colour string 태그 색상.
content.data[].tagInfo[].scope string 태그 적용 범위.
content.data[].points array<object> 선택한 비즈니스 날짜의 일별 결과(이른 날짜부터 늦은 날짜 순).
content.data[].points[].date string 비즈니스 날짜, YYYY-MM-DD.
content.data[].points[].availability number 또는 null 당일 가용성 비율(%), 최대 소수점 6자리까지 유지하며, 샘플이 없으면 null입니다.
content.data[].points[].level string goal에 도달하면 normal, goal 미만이지만 minGoal에 도달하면 warning, minGoal 미만이면 critical, 데이터가 없으면 unknown입니다.
content.data[].points[].hasData boolean 당일 사용 가능한 샘플이 있는지 여부.
content.data[].window object 요청에 window가 포함된 경우에만 반환됩니다.
content.data[].window.startTime integer 정확한 윈도우 시작 시간, Unix 초.
content.data[].window.endTime integer 정확한 윈도우 종료 시간, Unix 초.
content.data[].window.value number 윈도우 가용성 비율(%), 최대 소수점 6자리까지 유지.
content.data[].window.hasData boolean 전체 조회가 성공하면 true이며, 비용 샘플이 없는 경우도 포함합니다.
content.data[].window.dataState string 전체 윈도우 조회가 성공하면 complete입니다.
content.data[].window.updatedAt integer 또는 null 수정되지 않은 최신 비용 샘플의 Unix 초입니다. 해당 샘플이 없으면 null이며, 수정된 데이터도 여전히 가용성 계산에 참여할 수 있습니다.
content.declaration object 또는 null 워크스페이스 선언.
{
  "code": 200,
  "content": {
    "data": [
      {
        "sloUUID": "monitor_example",
        "name": "服务可用率",
        "status": 0,
        "goal": 99.9,
        "minGoal": 99.5,
        "tagInfo": [],
        "points": [
          {
            "date": "2026-07-31",
            "availability": null,
            "level": "unknown",
            "hasData": false
          }
        ],
        "window": {
          "startTime": 1785427200,
          "endTime": 1785430800,
          "value": 100,
          "hasData": true,
          "dataState": "complete",
          "updatedAt": null
        }
      }
    ],
    "declaration": null
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 필드 유형, 필수 여부 또는 제약 조건이 파라미터 표와 일치하지 않음 요청 필드 검증에 실패했으며, 메시지에 필드 또는 규칙이 표시됩니다. 필드, 유형 및 제약 조건을 확인하십시오.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류입니다. content의 reason, line, column을 읽고 수정하십시오.
400 ft.JsonFormatError JSON 구문은 유효하지만 최상위가 객체가 아님 JSON 형식 오류입니다. 파라미터를 JSON 객체에 넣으십시오.
400 ft.ParamsValidateError SLO 목록, 날짜 범위 또는 시간대가 유효하지 않음 파라미터 검증에 실패했으며, 상세 내용에 해당 필드가 포함됩니다. UUID 수, 날짜가 90일 이내인지 및 IANA 시간대를 확인하십시오.
400 ft.SloMetricUnsupportedOperation 메트릭 유형 SLO를 선택함 이 작업은 메트릭 유형 SLO에 적용되지 않습니다. 모니터 유형 SLO로 변경하거나 메트릭 유형 SLO의 실행 상태를 확인하십시오.
400 ft.StatusPage.invalid_parameter 정확한 윈도우가 날짜, 길이 또는 시간 경계를 충족하지 않거나 윈도우 조회의 UUID가 유효한 식별자가 아님 invalid_parameter Unix 초, 날짜 경계 및 SLO UUID를 확인하십시오.
404 ft.NotFoundSLO 요청의 SLO 중 하나라도 존재하지 않거나 삭제되었거나 현재 워크스페이스에 속하지 않음 지정된 SLO를 찾을 수 없습니다. 동일한 워크스페이스에서 SLO 목록을 다시 조회하십시오.
403 ft.ForbiddenQuery 대상 메트릭을 조회할 권한이 없음 조회 권한이 부족합니다. API Key의 메트릭 조회 권한을 확인하십시오.
503 ft.QueryServiceUnavailable 조회 서비스를 사용할 수 없음 조회 서비스를 일시적으로 사용할 수 없습니다. content.retryable에 따라 나중에 다시 시도할지 결정하십시오.
500 ft.InternalServerError 정확한 윈도우에서 불완전한 조회 결과를 읽음 내부 오류입니다. 나중에 다시 시도하고, 문제 해결을 위해 응답의 traceId를 보관하십시오.

문서 평가

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