목록 조회¶
GET /api/v1/data_mask_rule/list
개요¶
현재 워크스페이스에서 활성화 및 비활성화된 민감 데이터 마스킹 규칙을 페이지 단위로 나열합니다.
호출 전 및 사용 단계¶
이 조회 엔드포인트는 routine.defaultAccess 기본 접근 권한을 선언합니다. 규칙 정보를 읽을 수 있다고 해서 수정 권한이 있다는 의미는 아닙니다.
대상 워크스페이스의 API Key를 사용합니다. 이 구성 조회는 반환 단계의 독립적인 민감 규칙을 반환하며, 원본 저장 데이터를 변경하지 않고, 필드를 생성하지 않으며, 영구 삭제/익명화 API도 아닙니다.
규칙 이름으로 조회하고 uuid, 상태, 전체 표현식 및 역할 목록을 확인한 후 편집합니다.
search는 앞뒤 공백을 제거하지 않으며, 이름에 대한 퍼지 검색을 수행하고, %는 여전히 LIKE 와일드카드 의미를 가질 수 있습니다. 이 Query로 type/역할 기준 필터링은 할 수 없으므로 클라이언트에서 읽은 후 필터링하거나 페이지별로 처리해야 합니다. 페이지네이션은 기본 페이지당 100개, 최대 100개이며 id 내림차순으로 정렬됩니다. 역할 정보 표시는 해당 역할이 현재 조회 가능하거나 마스킹이 반드시 적용됨을 의미하지 않습니다.
적용 여부는 대상 쿼리 체인, 데이터 카테고리 및 실제 역할 집합에 따라 달라집니다. 역할 구성은 데이터 조회 권한 자체가 아닙니다. 동일 계정/Key에 해당 카테고리 조회 권한을 가진 역할이 여러 개 있을 때, 그중 하나의 역할에 적용 가능한 민감 규칙이 없으면 이 그룹의 규칙이 전체적으로 적용되지 않을 수 있습니다. 역할 하나만 바인딩하고 모든 조회자가 강제로 마스킹된다고 가정하지 마십시오. 실제 역할/Key로 데이터 조회 및 대상 표시 화면에서 검증하십시오. 현재 정규식 치환은 문자열 값만 처리합니다. 숫자, 객체, 배열, 불리언 및 null은 자동으로 문자열로 변환되어 마스킹되지 않습니다. 표준 쿼리에서 일치하는 문자열 부분은 *로 치환되고 나머지 텍스트는 유지됩니다. 정규식 저장 검사에는 regex 라이브러리를 사용하고, 쿼리 실행 경로에서는 표준 re를 사용하므로 Python 표준 re와 호환되는 문법만 사용할 것을 권장합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 획득합니다. |
Query 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| pageIndex | integer | 기본값 1, 최소 1입니다. null 허용: False $minValue: 1 예시: 1획득 또는 입력 방법: 1부터 시작하고 pageInfo에 따라 계속합니다. |
|
| pageSize | integer | 기본값 100, 최대 100입니다. null 허용: False $maxValue: 100 $minValue: 1 예시: 20획득 또는 입력 방법: 1~100 사이의 값을 입력합니다. |
|
| search | string | 선택 사항이며, 이름으로 일치시키고 필드나 정규식은 검색하지 않습니다. null 허용: False 예시: 验证码획득 또는 입력 방법: 규칙 이름 키워드를 입력하며, 필요하지 않으면 생략합니다. |
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/data_mask_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.data | array<object> | 이 페이지의 규칙이며 id 내림차순입니다. 일치 항목이 없거나 범위를 벗어나면 []이며, 비활성화된 규칙도 포함합니다. |
| content.declaration | object | 워크스페이스 공통 선언입니다. |
| content.data[*].id | integer | 레코드 번호이며 주소 지정에 사용되지 않습니다. |
| content.data[*].uuid | string | wdmk_ 규칙 UUID이며 상세 조회, 수정 및 일괄 작업에 사용됩니다. |
| content.data[*].workspaceUUID | string | 소속 워크스페이스입니다. |
| content.data[*].name | string | 규칙 이름이며, 현재 엔드포인트는 동일 이름의 고유성을 검사하지 않습니다. |
| content.data[*].type | string | 데이터 카테고리이며 적용 가능한 namespace를 결정합니다. |
| content.data[*].field | string | 필드 구성 원문이며 쉼표로 구분됩니다. 소비자는 각 항목의 앞뒤 공백을 자동으로 제거하지 않습니다. |
| content.data[*].reExpr | string | 저장된 정규식이며 사용자 정의 치환 텍스트를 포함하지 않습니다. |
| content.data[*].roleUUIDs | array<string> | 적용 역할 UUID이며, []는 모든 역할을 의미하지 않습니다. |
| content.data[*].roleUUIDs[*] | string | 역할 UUID 하나이며, 시스템 역할 식별자 또는 사용자 정의 role_ UUID일 수 있습니다. |
| content.data[*].status | integer | 0 활성화, 2 비활성화, 3 삭제됨입니다. 목록/상세에서는 3을 제외하고 2는 유지합니다. |
| content.data[*].creator | string | 생성 주체이며 Key UUID일 수 있습니다. |
| content.data[*].updator | string | 업데이트 주체이며, 아직 업데이트되지 않은 경우 빈 문자열입니다. |
| content.data[*].createAt | integer | 생성 시간(Unix 초)입니다. |
| content.data[*].updateAt | integer | 업데이트 시간(Unix 초)이며, 업데이트되지 않은 경우 -1일 수 있습니다. |
| content.data[*].deleteAt | integer | 삭제 시간(Unix 초)이며, 삭제되지 않은 경우 -1입니다. |
| content.data[*].roles | array<object> | 목록/상세에서 역할 정보를 보완합니다. 가시 범위 내에서 찾을 수 있는 역할만 포함하며, 과거에 삭제되었거나 비활성화된 상태를 포함할 수 있고 roleUUIDs와 개수가 일치한다고 보장하지 않습니다. |
| content.data[*].roles[*].uuid | string | 역할 UUID입니다. |
| content.data[*].roles[*].name | string 또는 null | 역할 표시 이름입니다. |
| content.data[*].roles[*].status | integer 또는 null | 역할의 현재 상태이며 실제 레코드를 기준으로 합니다. |
| content.data[*].creatorInfo | object | 목록에서만 주체 정보를 보완합니다. 찾을 수 없으면 {}이며, 시스템 주체 키는 더 적을 수 있습니다. |
| content.data[*].creatorInfo.uuid | string | 주체 UUID이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.status | integer | 주체 상태이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.wsAccountStatus | integer | 워크스페이스 멤버 상태이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.username | string | 사용자 이름/Key 이름이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.name | string | 이름이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.email | string | 이메일 또는 Key 식별자이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.mobile | string | 휴대폰 번호이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.countryCode | string | 국가 코드이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.iconUrl | string | 아이콘 URL이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].creatorInfo.acntWsNickname | string | 워크스페이스 닉네임이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo | object | 목록에서만 주체 정보를 보완합니다. 찾을 수 없으면 {}이며, 시스템 주체 키는 더 적을 수 있습니다. |
| content.data[*].updatorInfo.uuid | string | 주체 UUID이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.status | integer | 주체 상태이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.wsAccountStatus | integer | 워크스페이스 멤버 상태이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.username | string | 사용자 이름/Key 이름이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.name | string | 이름이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.email | string | 이메일 또는 Key 식별자이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.mobile | string | 휴대폰 번호이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.countryCode | string | 국가 코드이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.iconUrl | string | 아이콘 URL이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| content.data[*].updatorInfo.acntWsNickname | string | 워크스페이스 닉네임이며, 누락되었거나 비어 있을 수 있으므로 실제 반환값을 기준으로 합니다. |
| pageInfo.pageIndex | integer | 현재 페이지이며 1부터 시작합니다. |
| pageInfo.pageSize | integer | 페이지당 항목 수입니다. |
| pageInfo.count | integer | 현재 페이지의 항목 수입니다. |
| pageInfo.totalCount | integer | 필터링된 총 개수이며, 범위를 벗어난 페이지에서도 페이지네이션 기준으로 총 개수를 집계합니다. |
{
"code": 200,
"content": {
"data": [
{
"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
}
],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 | 파라미터 파싱 실패 | Query 파라미터 표와 예시를 확인하십시오. |
| 500 | ft.InternalServerError | 규칙 읽기, 과거 역할 데이터 또는 응답 포맷팅 실패 | 내부 오류 | traceId를 보관하고 구성을 확인한 후 다시 조회하십시오. |