민감 데이터 마스킹 테스트¶
POST /api/v1/workspace/sensitive_mask_rule/test
개요¶
시뮬레이션 데이터로 지정된 역할 조합의 민감 필드 마스킹 결과를 미리 봅니다.
호출 전 및 사용 단계¶
routine.defaultAccess 권한이 있는 현재 워크스페이스 Key를 사용합니다. 먼저 민감 필드 규칙 목록에서 namespace, 활성화 상태, 필드, 정규식 및 역할을 확인한 후, 시뮬레이션 데이터와 조합할 roleUUIDs를 전달합니다. 이 API는 전달된 샘플만 계산하며 원본 데이터를 조회하지 않고, 규칙이나 샘플을 저장하지 않으며, 현재 Key 권한을 변경하지 않습니다.
조합은 역할 읽기 권한과 마스킹 규칙을 함께 계산합니다. 참여한 읽기 가능 역할 중 하나에 해당 유형의 적용 규칙이 없으면 조합이 마스킹되지 않을 수 있으며, 여러 역할을 무조건 가장 엄격한 규칙을 중첩 적용하는 것으로 이해해서는 안 됩니다. 빈 역할 배열/규칙 없음 또는 규칙 조회 내결함성으로 인해 원본 그대로 반환될 수도 있으며, 이는 규칙이 유효함이나 규칙이 존재하지 않음을 증명하지 않습니다.
각 객체의 최상위 필드만 순회하며 필드 이름과 * 와일드카드 규칙을 매칭합니다. 기존 규칙 순서에 따라 Python re.sub로 매칭된 부분을 ***로 바꾸며, 깊은 재귀를 수행하거나 숫자를 자동으로 문자열로 변환하지 않습니다. 데이터 형태가 맞지 않거나, 유효 규칙의 정규식이 비정상이거나, 숫자가 정규식 처리 대상이 되면 500이 발생할 수 있습니다. 예시는 logging/general에 phone이 [0-9]{11}과 매칭되는 유효 규칙이 이미 존재한다고 가정합니다. 구성되지 않은 경우 원본 문자열이 반환될 수 있으며, 반드시 규칙과 예상 어서션을 대조해야 합니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| roleUUIDs[*] | string | 단일 문자열이며 현재 워크스페이스의 유효한 역할을 사용합니다. *를 실제 역할로 간주하여 모든 역할을 대체해서는 안 됩니다. 예시: general가져오기 또는 입력 방법: 실제 역할 UUID를 사용하고 name은 사용하지 않습니다. 여러 역할을 함께 사용하여 실제 조합을 시뮬레이션합니다. |
|
| data[*] | json | 단일 객체이며 {}는 유지됩니다. 잘못된 형태는 규칙이 존재할 때 500이 발생할 수 있으며, 느슨한 타입을 모든 데이터 형식을 지원하는 것으로 간주해서는 안 됩니다. 예시: {"phone": "13800138000", "message": "示例记录"}가져오기 또는 입력 방법: 필드는 실제 레코드와 같지만 값은 가상의 내용을 사용하는 시뮬레이션 데이터 한 건을 구성합니다. |
|
| data[*].필드명 | any | 동적 필드 값입니다. 필드 또는 * 와일드카드 필드와 매칭되면 규칙 순서에 따라 Python 정규식으로 매칭된 부분을 ***로 바꿉니다. 여러 규칙이 연속 적용되며, 원본 필드 값은 비즈니스 저장소에 기록되지 않습니다. 예시: 13800138000가져오기 또는 입력 방법: 검증할 실제 필드 이름을 사용하고, 가상 문자열로 매칭/비매칭 샘플을 구성합니다. |
|
| data | array | Y | 필수 배열이며 각 항목은 JSON 객체를 권장합니다. 최상위 필드만 처리하고 중첩 JSON은 재귀 처리하지 않습니다. 규칙과 매칭되지 않는 값은 유지됩니다. 매칭 규칙이 있는 필드는 문자열이어야 하며 숫자를 자동 변환하지 않습니다. null 허용: False 예시: [{"phone": "13800138000", "message": "示例记录"}]가져오기 또는 입력 방법: 실제 고객의 민감 정보가 포함되지 않은 시뮬레이션 JSON 객체 배열을 직접 제공합니다. 필드 이름은 기존 규칙에 대응하도록 바꿉니다. |
| namespace | string | Y | 필수이며 후보 값은 lineage, logging, metric, object, custom_object, keyevent, tracing, rum, security, network, profiling, billing입니다. 로그 인덱스 이름이 아닙니다. 이 엔드포인트는 실제 로그를 조회하지 않습니다. 빈 문자열 허용: False null 허용: False 선택 가능 값: ['lineage', 'logging', 'metric', 'object', 'custom_object', 'keyevent', 'tracing', 'rum', 'security', 'network', 'profiling', 'billing'] 예시: logging가져오기 또는 입력 방법: 샘플이 속한 데이터 유형을 선택하고, 먼저 전체 규칙 목록에서 동일한 type을 확인합니다. |
| roleUUIDs | array | Y | 필수 역할 UUID 배열이며, 시뮬레이션할 ID 조합을 나타내고 호출 Key의 역할을 수정하는 것이 아닙니다. 서버는 각 역할이 여전히 유효한지 항목별로 증명하지 않습니다. 알 수 없음/적용 가능한 규칙 없음 또는 역할 권한 불일치 시 원본 그대로 반환될 수 있습니다. []에 역할이 없으면 마스킹하지 않습니다. null 허용: False 예시: ["general"]가져오기 또는 입력 방법: 역할 목록 content.data[].uuid에서 시뮬레이션할 역할을 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/sensitive_mask_rule/test' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"roleUUIDs":["general"],"namespace":"logging","data":[{"phone":"13800138000","message":"示例记录"}]}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | array | 시뮬레이션 결과 배열이며 순서는 입력과 대응합니다. declaration은 삽입하지 않습니다. 적용 가능한 규칙이 없으면 입력과 완전히 동일할 수 있습니다. |
| content[] | object 또는 원본 입력 값 | 단일 샘플입니다. 입력 객체를 권장하며 빈 객체는 유지됩니다. |
| content[].필드명 | JSON | 입력 필드 및 원래 타입입니다. 정규식이 적용된 문자열의 매칭 부분은 ***로 바뀌고, 다른 값은 변경되지 않으며 메타데이터를 추가하지 않습니다. |
{
"code": 200,
"content": [
{
"phone": "***",
"message": "示例记录"
}
],
"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 | 규칙 조회 전 데이터베이스 실패, 객체가 아닌 항목, 문자열이 아닌 필드 또는 유효하지 않은 정규식이 처리 중 오류를 발생시켰습니다 | 내부 오류 | 객체 배열/문자열 샘플로 필드와 규칙을 확인하고 통제된 샘플에서 재현합니다. 구성 오류는 권한이 있는 관리자가 수정하며 traceId를 제공합니다. |