콘텐츠로 이동

조회



GET /api/v1/data_mask_rule/{data_mask_rule_uuid}/get

개요

현재 워크스페이스의 삭제되지 않은 마스킹 규칙 1개와 역할 정보를 조회합니다.

호출 전 및 사용 단계

이 조회 엔드포인트는 routine.defaultAccess 기본 접근 권한을 선언합니다. 규칙 정보를 조회할 수 있다고 해서 수정 권한이 있음을 의미하지는 않습니다.

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

목록 uuid로 조회하며 활성화 또는 비활성화된 레코드를 포함합니다. 저장된 전체 구성을 반환하고 roles는 보완하지만 목록의 creatorInfo/updatorInfo는 보완하지 않습니다. 역할 목록에는 과거 비활성 상태가 포함될 수 있으며, 쓰기 전 유효성 검증으로 사용되지 않습니다.

적용 여부는 대상 쿼리 체인, 데이터 카테고리 및 실제 역할 집합에 따라 달라집니다. 역할 구성은 데이터 쿼리 권한 부여 자체가 아닙니다. 동일한 계정/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를 가져옵니다.

요청 예시

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

응답

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

필드 유형 설명
content.id integer 레코드 번호이며 주소 지정에 사용되지 않습니다.
content.uuid string wdmk_ 규칙 UUID이며 상세 조회, 수정 및 일괄 작업에 사용됩니다.
content.workspaceUUID string 소속 워크스페이스입니다.
content.name string 규칙 이름이며 현재 엔드포인트는 동일 이름 고유성을 검사하지 않습니다.
content.type string 데이터 카테고리이며 적용 가능한 namespace를 결정합니다.
content.field string 필드 구성 원문이며 쉼표로 구분됩니다. 소비자는 각 항목의 앞뒤 공백을 자동으로 정리하지 않습니다.
content.reExpr string 저장된 정규식이며 사용자 정의 치환 텍스트를 포함하지 않습니다.
content.roleUUIDs array<string> 적용 가능한 역할 UUID이며 []는 모든 역할을 의미하지 않습니다.
content.roleUUIDs[*] string 역할 UUID 1개이며 시스템 역할 식별자 또는 사용자 정의 role_ UUID일 수 있습니다.
content.status integer 0은 활성화, 2는 비활성화, 3은 삭제됨입니다. 목록/상세에서는 3을 제외하고 2는 유지합니다.
content.creator string 생성 주체이며 Key UUID일 수 있습니다.
content.updator string 업데이트 주체이며 아직 업데이트되지 않은 경우 빈 문자열입니다.
content.createAt integer 생성 시간(Unix 초)입니다.
content.updateAt integer 업데이트 시간(Unix 초)이며 업데이트되지 않은 경우 -1일 수 있습니다.
content.deleteAt integer 삭제 시간(Unix 초)이며 삭제되지 않은 경우 -1입니다.
content.roles array<object> 목록/상세에서 역할 정보를 보완합니다. 표시 가능한 범위 내에서 찾을 수 있는 역할만 포함하며 과거 삭제/비활성 상태가 포함될 수 있고 roleUUIDs 수와 일치함을 보장하지 않습니다.
content.roles[*].uuid string 역할 UUID입니다.
content.roles[*].name string 또는 null 역할 표시 이름입니다.
content.roles[*].status integer 또는 null 역할의 현재 상태이며 실제 레코드를 기준으로 합니다.
content.declaration object 워크스페이스 공통 선언입니다.
{
  "code": 200,
  "content": {
    "id": 10,
    "uuid": "wdmk_example",
    "workspaceUUID": "wksp_example",
    "name": "验证码脱敏",
    "type": "logging",
    "field": "message",
    "reExpr": "(?<=验证码=)[0-9]{6}",
    "roleUUIDs": [
      "role_example"
    ],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "roles": [
      {
        "uuid": "role_example",
        "name": "自定义只读角色",
        "status": 0
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
404 ft.ObjectNotExists 대상 UUID가 현재 워크스페이스에 속하지 않거나, 존재하지 않거나, 삭제됨 지정한 객체가 존재하지 않습니다. 현재 워크스페이스 목록에서 유효한 UUID를 가져오십시오. 비활성화된 규칙도 조회할 수 있습니다.
500 ft.InternalServerError 규칙 조회, 과거 역할 데이터 또는 응답 형식 지정 실패 내부 오류 traceId를 보관하고 구성을 확인한 후 다시 조회하십시오.

문서 평가

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