콘텐츠로 이동

수정



POST /api/v1/data_mask_rule/{data_mask_rule_uuid}/modify

개요

현재 워크스페이스의 마스킹 규칙 구성을 전체 수정하며, 활성화/비활성화 상태는 유지합니다.

호출 전 및 사용 단계

이 쓰기 엔드포인트는 dataRightsManage.workspaceConfigManage 관리 권한이 필요합니다.

대상 워크스페이스의 API Key를 사용합니다. 이 구성 그룹은 조회 반환 단계의 독립적인 민감 규칙을 반환하며, 원본 저장 데이터를 재작성하지 않고, 필드를 생성하지 않으며, 영구 삭제/익명화 인터페이스도 아닙니다.

먼저 상세 정보를 읽어 백업하고, 규칙 uuid로 전체 name/type/field/reExpr/roleUUIDs를 제출합니다. 이는 부분 업데이트가 아닌 전체 구성 덮어쓰기입니다. 상태는 유지되며, 활성화/비활성화는 별도 인터페이스를 사용합니다.

쓰기는 먼저 제출한 뒤 해당 데이터 카테고리의 규칙 캐시를 삭제합니다(수정 시 신규/기존 카테고리를 정리). 캐시 실패는 제출 이후에 발생할 수 있습니다. 이후 실제 조회 주체를 기준으로 테스트해야 하며, 규칙 목록 저장 성공이 모든 쿼리 면과 캐시에서 검증되어 적용되었음을 의미하지는 않습니다.

적용 여부는 대상 쿼리 체인, 데이터 카테고리 및 실제 역할 집합에 따라 달라집니다. 역할 구성은 데이터 쿼리 권한 부여 그 자체가 아닙니다. 동일 계정/Key에 해당 카테고리 조회 권한이 있는 역할이 여러 개 있을 때, 그중 하나의 역할에 적용 가능한 민감 규칙이 없으면 이 규칙 그룹 전체가 적용되지 않을 수 있습니다. 역할 하나만 바인딩하고 모든 조회자에게 강제 마스킹이 적용된다고 가정하지 마세요. 실제 역할/Key로 쿼리 데이터 및 대상 표시 면에서 검증하세요. 현재 정규식 치환은 문자열 값만 처리합니다. 숫자, 객체, 배열, 불리언 및 null은 자동으로 문자열로 변환되어 마스킹되지 않습니다. 표준 쿼리에서 일치한 문자열 부분은 ***로 치환되고 나머지 텍스트는 유지됩니다. 저장 시 정규식 검사는 regex 라이브러리를 사용하고, 쿼리 실행 경로는 표준 re를 사용하므로 Python 표준 re 호환 문법만 사용할 것을 권장합니다.

라우팅 파라미터

파라미터명 타입 필수 설명
data_mask_rule_uuid string Y 현재 워크스페이스의 삭제되지 않은 규칙 UUID이며, 비활성 상태에서도 읽기/수정이 가능합니다.
예시: wdmk_example
획득 또는 입력 방법: 마스킹 규칙 목록 응답의 content.data[*].uuid에서 가져옵니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 타입 필수 설명
roleUUIDs[*] string 역할 UUID 한 개이며, 쓰기 전에 서버가 해당 UUID가 워크스페이스의 사용 가능한 역할 집합에 있는지 검사합니다.
예시: role_example
획득 또는 입력 방법: 역할 목록의 uuid를 항목별로 입력하고 역할 이름은 사용하지 않습니다.
field string Y 필수이며 비어 있을 수 없고 최대 128자입니다. 여러 필드는 영문 쉼표로 구분하며 공백을 넣지 않습니다. 예: message,phone. *를 포함하면 일치하는 모든 필드에 적용되므로, 범위를 명확히 하려면 *를 단독으로 사용할 것을 권장합니다.
빈 문자열 허용: False
null 허용: False
최대 길이: 128
예시: message
획득 또는 입력 방법: 해당 데이터 필드 조회에서 원본 필드명을 가져오며, 별칭은 입력하지 않습니다.
name string Y 필수이며 비어 있을 수 없고 최대 128자입니다. 현재 동일 이름을 허용하며, 이름 기준 멱등성은 보장하지 않습니다.
빈 문자열 허용: False
null 허용: False
최대 길이: 128
예시: 验证码脱敏
획득 또는 입력 방법: 규칙 용도를 입력하며, 먼저 목록에서 기존 구성을 조회하여 타임아웃 후 중복 생성되는 것을 방지합니다.
reExpr string Y 필수이며 비어 있을 수 없고 최대 5000자입니다. 예시에서는 验证码=123456을 验证码=***로 변환하며, 사용자 정의 치환 파라미터는 지원하지 않습니다. 일부 regex 확장 문법은 저장되지만 표준 re 실행에서 실패할 수 있으므로, 저장 성공만으로 사용 가능 여부를 판단할 수 없습니다.
빈 문자열 허용: False
null 허용: False
최대 길이: 5000
예시: (?<=验证码=)[0-9]{6}
획득 또는 입력 방법: 표준 Python re 호환 표현식을 입력하고 JSON 이스케이프를 적용합니다. 먼저 마스킹 테스트에서 통제된 샘플로 테스트할 수 있습니다.
roleUUIDs array Y 필수 배열입니다. 현재 검사는 삭제된 역할을 제외하며, 비활성이나 미삭제 역할은 통과할 수 있습니다. []는 명시적으로 일치하는 역할이 없음을 의미하며, 전체 역할을 의미하지 않습니다. *를 이 공개 인터페이스의 검증 면제 와일드카드 역할로 사용하지 마세요. 일반 역할 테이블에 해당 UUID가 없으면 404가 발생합니다.
null 허용: False
예시: ["role_example"]
획득 또는 입력 방법: 역할 목록에서 현재 워크스페이스의 사용 가능한 미삭제 역할 UUID를 가져옵니다. 시스템 역할은 목록의 실제 식별자를 사용합니다.
type string Y 필수입니다. 과거 선언에서는 null을 허용했지만, 클라이언트는 실제로 지원되는 카테고리를 선택해야 하며 null을 전체 카테고리로 간주해서는 안 됩니다. null은 신뢰할 수 있는 적용 규칙을 만들 수 없고, 수정 시 비어 있지 않은 저장 제약 조건을 위반할 수도 있습니다.
null 허용: True
선택 가능 값: ['lineage', 'logging', 'metric', 'object', 'custom_object', 'keyevent', 'tracing', 'rum', 'security', 'network', 'profiling', 'billing']
예시: logging
획득 또는 입력 방법: 실제 조회 데이터 카테고리에 따라 lineage/logging/metric/object/custom_object/keyevent/tracing/rum/security/network/profiling/billing 중에서 선택합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/data_mask_rule/wdmk_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"验证码脱敏","type":"logging","field":"message","reExpr":"(?<=验证码=)[0-9]{6}","roleUUIDs":["role_example"]}'

응답

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 파일 형식 오류 예시에 따라 객체를 제출합니다.
404 ft.ObjectNotExists 대상 UUID가 현재 워크스페이스에 속하지 않거나, 존재하지 않거나, 삭제됨 지정된 객체가 존재하지 않음 현재 워크스페이스 목록에서 유효한 UUID를 가져옵니다. 비활성 규칙도 읽을 수 있습니다.
404 ft.NotFoundRole roleUUIDs 구성원 중 하나라도 현재 워크스페이스에서 사용 가능한 미삭제 역할 집합에 없음 지정된 역할을 찾을 수 없거나 역할이 삭제됨 역할 목록에서 UUID를 다시 가져옵니다. 이름, 외부 워크스페이스 역할 또는 *를 사용하지 않습니다.
400 ft.ErrorRegularExpression 저장 시 정규식 사전 검사 실패 정규식 오류 유효하고 표준 re와 호환되는 표현식으로 변경하고 JSON 백슬래시 이스케이프를 확인합니다.
500 ft.InternalServerError 저장 또는 응답 실패, 쓰기 제출 후 캐시 삭제 실패 시에도 500이 발생할 수 있음 내부 오류 쓰기 요청은 먼저 목록/상세 조회로 읽어 확인한 후 재시도 여부를 결정하고, traceId를 보관하여 관리자에게 문의합니다.

문서 평가

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