활성화/비활성화¶
POST /api/v1/data_mask_rule/set_disable
개요¶
현재 워크스페이스의 마스킹 규칙을 일괄 활성화하거나 비활성화합니다.
호출 전 및 사용 단계¶
이 쓰기 API에는 dataRightsManage.workspaceConfigManage 관리 권한이 필요합니다.
대상 워크스페이스의 API Key를 사용합니다. 이 구성 그룹은 쿼리 반환 단계의 독립적인 민감 규칙을 구성하며, 원본 저장 데이터를 다시 쓰지 않고 필드를 생성하지 않으며 영구 삭제/익명화 API도 아닙니다.
이번 배치에서 일치하는 규칙을 일괄 활성화하거나 비활성화합니다. 비활성화 후 해당 규칙은 더 이상 활성화된 구성으로 후속 쿼리에 참여하지 않으며, 역할의 쿼리가 금지된다는 의미는 아닙니다. true를 반환한다고 해서 요청 배열의 모든 항목이 일치했다는 의미는 아니며, 빈 배치나 전혀 일치하지 않은 경우에도 성공할 수 있습니다. 목록을 안전하게 확인한 뒤 알려진 상태를 다시 처리하여, 일치하지 않은 항목을 변경 성공으로 간주하지 않도록 해야 합니다. 데이터베이스 커밋 후 일치한 범주에 따라 규칙 캐시를 지웁니다. 캐시 삭제에 실패하면 500이 발생할 수 있지만 상태는 이미 커밋되었으므로 재시도 전에 다시 읽어 확인합니다.
적용 여부는 대상 쿼리 체인, 데이터 범주 및 실제 역할 집합에 따라 달라집니다. 역할 구성은 그 자체로 데이터 쿼리 권한이 아닙니다. 동일한 계정/Key에 해당 범주의 쿼리 권한이 있는 역할이 여러 개 있고 그중 한 역할에 적용 가능한 민감 규칙이 없으면, 이 규칙 그룹 전체가 적용되지 않을 수 있습니다. 역할을 하나만 바인딩했다고 해서 모든 조회자에게 마스킹이 강제된다고 가정하지 마세요. 실제 역할/Key로 데이터 쿼리 및 대상 표시 화면에서 검증하세요. 현재 정규식 치환은 문자열 값만 처리합니다. 숫자, 객체, 배열, 불리언, null은 자동으로 문자열로 변환되어 마스킹되지 않습니다. 표준 쿼리에서 일치하는 문자열 부분은 *로 치환되고 나머지 텍스트는 유지됩니다. 정규식 저장 검사에는 regex 라이브러리를 사용하고 쿼리 실행 경로에서는 표준 re를 사용하므로, Python 표준 re와 호환되는 문법만 사용할 것을 권장합니다.
요청 헤더¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 매개변수¶
| 매개변수 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| dataMaskRuleUUIDs[*] | string | 각 항목을 비어 있지 않은 문자열로 지정하는 것이 좋으며, true로 모든 UUID가 일치한다고 판단하지 않습니다. 예: wdmk_example가져오기 또는 입력 방법: 이름이 아닌 단일 규칙 UUID를 입력합니다. |
|
| dataMaskRuleUUIDs | array | Y | 필수 배열입니다. []는 성공할 수 있지만 규칙은 변경하지 않습니다. 현재 워크스페이스의 삭제되지 않은 레코드만 처리하며, 알 수 없거나 외부 워크스페이스에 속하거나 이미 삭제된 UUID는 일치하지 않아도 항목별 오류를 발생시키지 않습니다. null 허용: False 예: ["wdmk_example"]가져오기 또는 입력 방법: 마스킹 규칙 목록에서 대상 규칙 uuid를 항목별로 선택합니다. |
| isDisable | boolean | Y | 필수 불리언입니다. 일치하는 규칙에 대해 status=2 또는 0을 일괄 설정하며, 삭제된 규칙은 복원하지 않습니다. null 허용: False 예: true가져오기 또는 입력 방법: 비활성화하려면 true, 활성화하려면 false를 입력합니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/data_mask_rule/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"dataMaskRuleUUIDs":["wdmk_example"],"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 처리가 완료되면 true를 반환하며, 일치 수나 항목별 상태는 포함하지 않습니다. |
{
"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 파일 형식 오류 | 예시에 따라 객체를 제출하세요. |
| 500 | ft.InternalServerError | 저장 또는 응답 실패, 쓰기 커밋 후 캐시 삭제 실패로도 500이 발생할 수 있음 | 내부 오류 | 쓰기 요청은 먼저 목록/상세에서 다시 읽어 확인한 후 재시도 여부를 결정하세요. traceId를 보관하고 관리자에게 문의하세요. |