콘텐츠로 이동

역할별 민감 데이터 마스킹 필드 조회



GET /api/v1/workspace/role/sensitive_mask_fields

개요

워크스페이스의 각 역할에 적용되는 민감 필드 마스킹 표현식 요약을 조회합니다.

호출 전 준비 및 사용 단계

routine.defaultAccess 권한이 있는 현재 워크스페이스 Key를 사용하며, Query/Body는 필요하지 않습니다. 삭제되지 않은 마스킹 규칙이 참조하는 역할 UUID를 기준으로 현재 유효하게 사용 가능한 역할을 조회한 뒤, 각 역할의 조회 권한과 활성 마스킹 규칙에 따라 요약을 생성합니다. 모든 역할의 전체 목록은 아닙니다. *와일드카드 규칙에만 나타나거나 특정 역할에서 참조되지 않은 역할은 이 요약에 포함되지 않을 수 있으므로, 역할 목록 및 전체 규칙 설정과 함께 판단해야 합니다.

실제로 일치하는 규칙이 있는 데이터 유형/역할/필드만 나열합니다. 일치 항목이 없으면 content={}이며, 빈 매핑만으로 규칙이 존재하지 않는다거나 모든 쿼리가 마스킹되지 않는다고 증명할 수 없습니다. 내부 규칙 조회에는 내결함성이 적용되어 있어, 예외 상황에서도 빈 규칙이 반환될 수 있습니다. 이 페이지는 규칙 점검 용도이며, 원본 고객 데이터를 반환하지 않고, 규칙을 수정하지 않으며, 데이터 읽기 권한을 설정하지도 않습니다. 규칙 전체 내용/활성화 여부는 민감 필드 규칙 목록을 사용하십시오.

요청 헤더

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

요청 예시

curl --get 'https://openapi.guance.com/api/v1/workspace/role/sensitive_mask_fields' \
  -H 'DF-API-KEY: <DF-API-KEY>'

응답

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

필드 유형 설명
content object namespace→역할 UUID→필드 이름 순으로 구성되는 동적 매핑이며 {}일 수 있습니다. declaration은 삽입되지 않습니다.
content.데이터 유형 object 일치 항목이 있을 때만 나타납니다. 후보: lineage,logging,metric,object,custom_object,keyevent,tracing,rum,security,network,profiling,billing.
content.데이터 유형.역할 UUID object 구체적으로 유효한 역할의 필드 매핑입니다. Key는 표시 이름이 아닌 역할 UUID입니다.
content.데이터 유형.역할 UUID.필드 이름 array<object> 해당 필드에 적용되는 규칙 요약 배열입니다. *는 와일드카드 필드이며, 쉼표로 구분된 필드는 여러 키로 분리됩니다.
content.데이터 유형.역할 UUID.필드 이름[].reExpr string 저장된 정규 표현식입니다.
content.데이터 유형.역할 UUID.필드 이름[].name string 마스킹 규칙 이름이며 비어 있을 수 있습니다.
content.데이터 유형.역할 UUID.필드 이름[].id integer 마스킹 규칙의 데이터베이스 숫자 ID이며, 수정 경로에 사용하는 규칙 uuid가 아닙니다.
content.데이터 유형.역할 UUID.필드 이름[].updateAt integer 최근 업데이트 시각(Unix 초)이며, 이력상 갱신되지 않은 경우 -1일 수 있습니다.
{
  "code": 200,
  "content": {
    "logging": {
      "general": {
        "phone": [
          {
            "reExpr": "[0-9]{11}",
            "name": "手机号示例",
            "id": 101,
            "updateAt": 1785427200
          }
        ]
      }
    }
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하십시오.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
500 ft.InternalServerError 초기 규칙/역할/권한 데이터베이스 조회 또는 요약 포맷팅 실패. 내부 일부 규칙 오류는 {}로 내결함성 처리될 수 있습니다. 내부 오류 전체 규칙 목록과 함께 확인하고, 빈 결과를 데이터 보안 검수 결과로 간주하지 마십시오. 지속적으로 실패하면 traceId를 제공하십시오.

문서 평가

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