활성화¶
POST /api/v1/monitor/mute/{mute_uuid}/enable
개요¶
현재 워크스페이스의 음소거 규칙을 활성화합니다.
호출 전 및 사용 단계¶
먼저 현재 워크스페이스 목록에서 대상을 확인한 후 활성화하고, 완료 후 규칙과 실제 적용 상태를 다시 조회합니다.
활성화하면 규칙의 status가 0으로 설정되며 기존 시간은 유지됩니다. 만료된 규칙은 이로 인해 자동으로 연장되거나 즉시 적용되지 않습니다. 캐시는 비동기로 동기화되며, 여전히 유효한 시간/대상에 따라 규칙에 설정된 알림을 스케줄링합니다.
현재 일치하는 레코드가 없으면 404 대신 500이 반환될 수 있습니다. 오류만 보고 쓰기가 발생하지 않았다고 판단하지 말고, 먼저 유효한 UUID를 다시 읽으십시오.
경로 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| mute_uuid | string | Y | 현재 워크스페이스 음소거 규칙의 경로 UUID입니다. 예시: mute_example가져오기 또는 입력 방법: 음소거 규칙 목록의 content.data[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/monitor/mute/mute_example/enable' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true입니다. 실제 적중 및 비동기 상태 경계는 사용 안내를 참조하십시오. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반했습니다 | 파라미터 구문 분석 실패 | 파라미터 위치, 필드명, 타입 및 값을 확인하십시오. |
| 500 | ft.InternalServerError | 대상이 없거나 삭제되었거나 워크스페이스 간인 경우 활성화 분기가 실패할 수 있으며, 저장/동기화에 실패할 수 있습니다 | 내부 오류 | 현재 워크스페이스 목록에서 UUID와 현재 상태를 확인한 후 재시도하십시오. 계속 실패하면 traceId를 제공하십시오. |