비활성화/활성화¶
POST /api/v1/data_query_rule/set_disable
개요¶
데이터 액세스 규칙을 일괄 활성화/비활성화합니다.
호출 전 확인 및 사용 단계¶
먼저 UUID와 영향을 받는 ID를 확인한 후 일괄 제출합니다. 활성화/비활성화는 규칙의 status만 변경하며 원본 데이터를 변경하지 않고 진행 중인 쿼리도 회수하지 않습니다. 비활성화는 해당 규칙이 이후 범위/마스킹 계산에 더 이상 참여하지 않음을 의미하므로 최종 권한을 다시 검수해야 합니다. true만 반환하고 항목별 결과는 제공하지 않으며, 일부 UUID가 유효하지 않더라도 이로 인해 404가 발생하지는 않습니다.
현재 전부 매칭되지 않는 경우([], 전부 알 수 없음/교차 워크스페이스 또는 삭제된 UUID 포함) controller가 감사 컨텍스트를 설정하지 않아 이후 공개 route에서 이를 읽을 때 500이 발생할 수 있습니다. 이는 어떤 변경이 발생했음을 증명하지 않습니다. 먼저 목록에서 비어 있지 않은 유효 대상을 가져오고, 오류 발생 후에는 상태를 다시 조회하십시오.
쓰기는 설정을 교체하고 데이터베이스에 커밋한 뒤 규칙 캐시를 비우고 감사를 기록합니다. 교차 사이트 검증은 리소스 정보를 읽거나 업데이트할 수도 있습니다. 단계가 단일 원자 트랜잭션이 아니므로 500/타임아웃 후에는 먼저 목록/상세에서 저장 여부를 확인하여 무작정 중복 추가하지 마십시오.
규칙 저장은 이후 조건에 부합하는 ID의 데이터 쿼리 범위/결과 마스킹에 영향을 주며, 원본 데이터를 수정, 삭제 또는 보충 수집하지 않고 역할의 기본 쿼리 권한도 추가하지 않습니다. 여러 역할 및 규칙은 쿼리 측 정책에 따라 병합되므로 단일 규칙만으로 최종 권한을 추론할 수 없습니다. Owner는 예외이며, 관리자 및 워크스페이스의 "데이터 액세스 범위 제한" 설정은 매칭되는 역할이 없을 때의 처리를 변경하므로 대표 구성원의 실제 쿼리로 검수해야 합니다. 저장 후에는 규칙 캐시가 무효화되지만 모든 진행 중인 쿼리가 즉시 전환됨을 보장하지는 않습니다.
요청 헤더¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>획득 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 타입 | 필수 | 설명 |
|---|---|---|---|
| queryRuleUuids[*] | string | 단일 비어 있지 않은 UUID로, 원래 선언에서는 항목별 검증을 수행하지 않습니다. 예시: lqrl_example획득 또는 입력 방법: 단일 규칙 uuid입니다. |
|
| isDisable | boolean | Y | 필수 JSON 불리언입니다. true는 status=2, false는 0으로 저장하며 삭제된 규칙은 복구하지 않습니다. null 허용: False 예시: true획득 또는 입력 방법: 규칙을 일시 중지하려면 true, 다시 활성화하려면 false를 사용합니다. |
| queryRuleUuids | array | Y | 필수 배열이며 비어 있지 않은 것을 권장합니다. 현재 워크스페이스의 삭제되지 않은 매칭 항목만 대상으로 하며, 로그 모듈은 추가로 logging으로 제한됩니다. null 허용: False 예시: ["lqrl_example"]획득 또는 입력 방법: 데이터 액세스 규칙 목록에서 대상 UUID 집합을 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"queryRuleUuids":["lqrl_example"],"isDisable":true}'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | boolean | 성공 시 true이며, 항목별 결과가 아니므로 입력한 모든 UUID가 수정되었음을 의미하지는 않습니다. |
{
"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을 수정하십시오. |
| 500 | ft.InternalServerError | 배열 항목 형태 불일치, 필드가 저장 길이를 초과, 다운스트림 일반 5xx, 데이터베이스 또는 커밋 후 캐시 실패 | 내부 오류 | 본문의 구조와 길이를 확인하고 현재 설정을 읽어 데이터베이스 반영 여부를 확인한 후 재시도 여부를 결정하고 traceId를 제공하십시오. |