비활성화/활성화¶
POST /api/v1/slo/{slo_uuid}/set_disable
개요¶
지정된 SLO의 활성화/비활성화 상태를 설정합니다.
호출 전 및 사용 단계¶
현재 API Key에는 monitor.sloCfgManage 권한이 필요합니다. 메트릭 유형 저장에는 대상 메트릭 namespace 조회 권한도 필요하며, SLO 관리 권한만으로는 이 사전 검사를 통과할 수 없습니다. Key가 속한 워크스페이스만 조작합니다. 경로의 SLO UUID는 SLO 목록 가져오기의 content.data[].uuid(일반적으로 monitor_ 접두사)에서 가져오며, 연결된 모니터의 Rule UUID 또는 metricQueryInfo.sloId가 아닙니다.
활성화/비활성화는 SLO와 연결된 감지/계산 컴포넌트 및 원격 스케줄링을 동시에 조정합니다. 이번에 상태가 실제로 변경된 SLO 이름 배열만 반환하며, 전체 요청 UUID나 항목별 성공 매핑이 아닙니다. 이미 대상 상태이면 []를 반환하고 원격을 다시 수정하지 않습니다. 대상이 유효하지 않거나 삭제되었거나 다른 워크스페이스에 있으면 NotFoundSLO입니다.
메트릭 유형을 비활성화하면 중지 시간이 기록됩니다. 비활성화 상태에서 다시 활성화하면 validAfter가 재설정되며, 복구 후 통계는 기존 유효 구간에 직접 합산되어서는 안 됩니다. 모니터 유형을 일시 중지해도 원래 SLI 모니터는 삭제되지 않습니다. 이번 작업은 원래 모니터 자체의 일시 중지를 담당하지 않습니다. 생성, 수정 및 활성화/비활성화는 로컬 트랜잭션 마지막에 커밋되며, 실패하면 원격 스케줄링과 캐시 복구를 시도합니다. 원격 보상도 실패할 수 있으므로 HTTP 실패만으로 모든 시스템에 변경이 없다고 판단해서는 안 됩니다. 네트워크 타임아웃/500 발생 후에는 먼저 SLO 상세 가져오기로 구성과 상태를 확인하고, 필요한 경우 관리자에게 스케줄링을 확인한 후 재시도하세요. 저장 성공이 이미 감지 결과가 생성되었음을 의미하지 않으므로, 감지 주기를 기다린 후 실제 데이터를 확인해야 합니다.
경로 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| slo_uuid | string | Y | 대상 SLO UUID이며, SLI 모니터 UUID 또는 metricQueryInfo.sloId가 아닙니다. 예: monitor_example가져오기 또는 입력 방법: SLO 목록 가져오기에서 content.data[].uuid를 읽습니다. |
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| isDisable | boolean | Y | 필수 boolean이며, true는 비활성화, false는 활성화이고 문자열이나 null은 허용되지 않습니다. 비활성화해도 구성은 삭제되지 않습니다. null 허용: False 예: true가져오기 또는 입력 방법: SLO 감지를 일시 중지할지 여부에 따라 선택합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/slo/monitor_example/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | array<string> |
이번에 실제로 상태가 변경된 SLO 이름이며, 변경이 없으면 []이고 순서는 보장되지 않습니다. |
| content[] | string | 상태가 변경된 SLO 하나의 이름입니다. |
{
"code": 200,
"content": [
"支付服务可用性"
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
{
"code": 200,
"content": [],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 매개변수 파싱 실패 | 매개변수 위치, 필드 이름, 유형 및 값을 확인하세요. |
| 400 | ft.RequestJsonFormatError | 요청 JSON 구문이 유효하지 않음 | 요청 JSON 형식 오류 | content.reason, line, column에 따라 JSON을 수정하세요. |
| 400 | ft.JsonFormatError | JSON 최상위가 객체가 아님 | 일부 json 파일 형식 오류 | 객체를 제출하세요. |
| 404 | ft.NotFoundSLO | 대상이 현재 워크스페이스에 없거나, 삭제되었거나 SLO가 아님; 수정에는 필요한 감지/계산 컴포넌트 누락도 포함됩니다 | 지정된 SLO를 찾을 수 없음 | 현재 워크스페이스의 SLO 목록에서 uuid를 가져오고, 대상이 여전히 존재하는지 확인하세요. 컴포넌트가 누락된 경우 관리자에게 복구를 요청하세요. |
| 400 | ft.OuterFuncFailed | 원격 스케줄링 서비스가 실패를 반환함 | 외부 함수 호출 실패(일부 분기에서는 다운스트림 message 사용) | message와 traceId를 확인하고, 관리자에게 스케줄링 가용성 및 현재 구성 상태를 확인한 후 재시도하세요. |
| 400 | ft.SameSetTraggerExists | 원격 스케줄링 서비스가 동일한 트리거 구성이 이미 존재한다고 보고함 | 동일한 구성의 트리거가 이미 존재함 | 먼저 해당 SLO와 원격 스케줄링을 확인하고, 잔여/중복 구성을 처리한 후 다시 제출하세요. |
| 500 | ft.InternalServerError | 데이터베이스/캐시, 작업 큐, 잘못된 배열 멤버 또는 처리되지 않은 다운스트림 예외; 실패 시에도 원격 변경이 이미 발생했을 수 있음 | 내부 오류 | 먼저 대상 SLO 구성과 현재 스케줄링 상태를 확인하세요. 삭제 실패의 경우 삭제된 상태도 별도로 확인해야 하며, 무작정 반복 생성하거나 일괄 덮어쓰지 마세요. |