콘텐츠로 이동

활성화/비활성화



POST /api/v1/blacklist/batch_set_disable

개요

현재 공개 계약에 따라 블랙리스트 규칙을 일괄 활성화합니다.

호출 전 및 사용 단계

먼저 목록에서 각 UUID, 규칙 이름 및 범위를 확인한 후 문자열 배열을 제출합니다. 서버는 현재 워크스페이스의 삭제되지 않은 일치 항목만 처리하며, 빈 배열, 모두 알 수 없는 UUID 또는 다른 워크스페이스의 UUID도 true를 반환할 수 있고 항목별 일치 결과는 제공하지 않습니다.

현재 공개 Body에는 blacklistUUIDs만 선언되어 있고 isDisable이 없습니다. 이 필드를 전달하지 않으면 route의 기본값은 false이므로, 현재 공개 요청에 따라 비활성화된 규칙을 status=0으로 복원할 수 있습니다. isDisable=true를 제출하면 알 수 없는 필드 검증에서 거부되며, 페이지의 기존 명칭에 근거하여 완전한 비활성화 기능을 보장할 수 없습니다. 비활성화가 필요하면 콘솔을 사용하세요. 활성화된 레코드는 그대로 유지되고, 삭제된 레코드는 복구되지 않습니다. 이것은 블랙리스트 규칙 구성 API이며 과거 데이터 삭제 API가 아닙니다. 저장 응답은 규칙 레코드 처리가 완료되었음만 증명하며, 다운스트림 수집/처리 파이프라인의 적용 진행 상황이나 알림 결과는 제공하지 않습니다. 출시 전에 통제된 샘플로 실제 필터링 범위를 확인하고, 소스/조건이 없는 광범위한 규칙을 피하세요. 무료 플랜 워크스페이스는 이 그룹의 명세에서 제한되므로, 이 기능을 지원하는 워크스페이스와 해당 API Key 권한을 사용해야 합니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Body 요청 파라미터

파라미터 이름 유형 필수 설명
blacklistUUIDs[*] string 문자열 요소이며 null, 숫자 또는 객체를 전달하지 마세요. 그렇지 않으면 strip 처리에서 500이 발생할 수 있습니다.
예시: blist_example
가져오기 또는 입력 방법: 블랙리스트 목록에서 단일 규칙 uuid를 가져옵니다.
blacklistUUIDs array Y 필수 규칙 UUID 배열이며 쉼표로 구분된 문자열이 아닙니다. 서버는 각 항목의 앞뒤 공백을 제거하고 빈 문자열은 무시합니다. 일부 일괄 작업에서는 일치하지 않는 UUID가 무시되므로 항목별로 계속 확인해야 합니다.
null 허용: False
예시: ["blist_example"]
가져오기 또는 입력 방법: 블랙리스트 목록에서 실제 uuid를 가져옵니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/blacklist/batch_set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"blacklistUUIDs":["blist_example"]}'

응답

HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content boolean 성공하면 true입니다. 모든 UUID가 일치했거나 상태가 변경되었음을 의미하지는 않습니다.
{
  "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 파일 형식 오류 파라미터 표의 JSON 객체를 제출하세요.
500 ft.InternalServerError 데이터베이스, 저장소 길이/null, 필드 형태 또는 후속 처리 예외 내부 오류 먼저 규칙 및 해당 구성을 조회한 후 재시도 여부를 결정하세요. 지속적으로 실패하면 traceId를 보관하세요.
403 ft.Forbidden API Key에 해당 작업 권한이 없거나 워크스페이스 버전이 블랙리스트 기능을 지원하지 않음 작업 권한이 없습니다 해당 권한이 있는 API Key와 이 기능을 지원하는 워크스페이스를 사용하세요.

문서 평가

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