비활성화/활성화¶
POST /api/v1/error_track_rule/set_disable
개요¶
오류 추적 규칙을 일괄 활성화하거나 비활성화합니다.
호출 전 및 사용 단계¶
현재 Key에는 errorCenter.errorTrackRuleManage 권한이 필요하며, 현재 워크스페이스에만 적용됩니다. 일괄 UUID는 먼저 삭제되지 않은 항목을 필터링하며, 비활성화된 규칙도 포함합니다. 알 수 없거나 다른 워크스페이스에 속하거나 삭제된 항목은 그대로 무시됩니다. []이거나 모두 유효하지 않은 경우에도 true를 반환하며, 적중 수나 항목별 결과는 없습니다. 성공했다고 해서 모든 입력이 적용되었음이 증명되지는 않으므로 반드시 목록/상세를 다시 읽어 확인해야 합니다.
isDisable은 반드시 true/false를 명시해야 하며, 생략하면 실제로는 활성화됩니다. 적중된 항목은 원래 상태가 동일하더라도 업데이트 시간이 갱신됩니다. 비활성화는 상태만 저장할 뿐 규칙이나 과거 오류를 삭제하지 않으며, 활성화를 모든 과거 데이터가 즉시 처리되는 것으로 간주할 수 없습니다. 후속 산출물은 검증이 필요합니다.
이 컨트롤러는 동기화 작업이나 하위 시스템 확인 결과를 반환하지 않습니다. 실패 후에는 먼저 다시 읽어 확인하여 네트워크 오류를 미갱신으로 오인하지 않도록 하세요. 알 수 없는 항목이 무시되는 것은 전체 배치에 대한 원자적 보장을 의미하지 않습니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>발급 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 발급받습니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| ruleUUIDs[*] | any | 단일 규칙 UUID로, 문자열을 권장합니다. 원래 선언에는 요소별 타입/비어 있지 않음 검증이 없으므로 클라이언트가 직접 확인해야 합니다. 예시: issetrule_example발급 또는 입력 방법: 현재 워크스페이스 규칙 목록의 uuid입니다. |
|
| isDisable | boolean | 선택적 불리언이며 null은 거부됩니다. true이면 status=2, false이면 0으로 설정합니다. 생략하면 컨트롤러에 None으로 전달되어 실제로는 활성화 0으로 처리되므로, 반드시 매번 명시적으로 제공하여 의도치 않은 활성화를 방지해야 합니다. null 허용: False 예시: true발급 또는 입력 방법: 호출자가 비활성화 true 또는 활성화 false를 명확히 선택합니다. |
|
| ruleUUIDs | array | Y | 필수 배열이며 []이면 적중 항목이 없습니다. 현재 워크스페이스의 status!=3 항목만 참여하며, 알 수 없거나 다른 워크스페이스에 속하거나 삭제된 항목은 무시되고 항목별 실패 목록은 없습니다. null 허용: False 예시: ["issetrule_example"]발급 또는 입력 방법: 규칙 목록에서 content.data[].uuid를 가져와 현재 상태/유형을 확인합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["issetrule_example"],"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며 적중 항목이 없는 경우도 포함합니다. declaration, 적중 수 또는 항목별 상태는 포함되지 않습니다. |
{
"code": 200,
"content": true,
"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 파일 형식 오류 | ruleUUIDs를 포함하는 객체를 제출합니다. |
| 500 | ft.InternalServerError | 데이터베이스 또는 과거 규칙 형식 등 처리되지 않은 예외 | 내부 오류 | 규칙 상태를 다시 읽은 후 재시도 여부를 결정합니다. traceId를 보존하며, 실패를 근거로 모든 항목이 저장되지 않았다고 단정할 수 없습니다. |