내보내기¶
POST /api/v1/blacklist/export
개요¶
지정한 블랙리스트의 마이그레이션 가능한 구성 JSON을 내보냅니다.
호출 전 준비 및 사용 단계¶
대상 규칙 UUID 배열을 제출합니다. 응답은 application/json 공통 래퍼이며 파일 다운로드/CSV/압축 파일이 아니고 비동기 작업도 아닙니다. content.blacklists 배열을 가져와 가져오기 시 Body.blacklists에 사용합니다. 일치 항목이 비어 있지 않으면 일치한 항목만 내보내며, 요청된 모든 UUID가 빠짐없이 포함되었는지는 확인하지 않습니다. 전혀 일치하지 않으면([] 포함) 404를 반환합니다.
내보내기에는 uuid, 워크스페이스, status, conditions 또는 생성자 정보가 포함되지 않으므로 원래 비활성화 상태를 유지하는 데 사용할 수 없습니다. 워크스페이스 리소스 패키지 내보내기의 is_disable은 다른 흐름에 속하며 이 API의 필드가 아닙니다. 마이그레이션 전에 대상 워크스페이스에 동일한 필드와 소스가 존재하는지 확인합니다.
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| blacklistUUIDs[*] | string | 문자열 요소이며 null, 숫자 또는 객체를 전달하지 마세요. 그렇지 않으면 strip 처리에서 500이 발생할 수 있습니다. 예시: blist_example가져오기 또는 입력 방법: 블랙리스트 목록에서 단일 규칙 uuid를 가져옵니다. |
|
| blacklistUUIDs | array | Y | 필수 규칙 UUID 배열이며 쉼표로 구분된 문자열이 아닙니다. 서버는 각 항목의 앞뒤 공백을 제거하고 빈 문자열을 무시합니다. 일부 일괄 작업에서는 일치하지 않는 UUID가 무시되므로 항목별로 계속 확인해야 합니다. null 허용: False 예시: ["blist_example"]가져오기 또는 입력 방법: 블랙리스트 목록에서 실제 uuid를 가져옵니다. |
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/blacklist/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"blacklistUUIDs":["blist_example"]}'
응답¶
HTTP 200, application/json. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.blacklists | array<object> |
가져오기 blacklists의 구성 배열로 직접 사용할 수 있으며, 현재 워크스페이스에서 삭제되지 않은 일치 항목만 포함합니다. |
| content.blacklists[].name | string | 규칙 이름. |
| content.blacklists[].desc | string | 규칙 설명. |
| content.blacklists[].type | string | 데이터 카테고리. |
| content.blacklists[].source | string | 저장된 단일/전체 소스 표현이며 비어 있을 수 있습니다. |
| content.blacklists[].sources | array<string> |
저장된 여러 소스 이름이며, 비어 있지 않으면 우선합니다. |
| content.blacklists[].sources[] | string | 단일 소스 이름. |
| content.blacklists[].filters | array<object> 또는 object 또는 null | 원시 조건 배열이며 기존 레코드에서는 {} 또는 null일 수 있습니다. |
| content.declaration | object | 공통 선언이며 가져오기의 단일 blacklist 객체에 포함되지 않습니다. |
{
"code": 200,
"content": {
"blacklists": [
{
"name": "忽略健康检查日志",
"desc": "过滤生产nginx健康检查请求。",
"type": "logging",
"source": "nginx",
"sources": [],
"filters": [
{
"name": "path",
"condition": "and",
"operation": "=",
"value": [
"/healthz"
]
}
]
}
],
"declaration": {}
},
"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 객체를 제출합니다. |
| 404 | ft.InvalidBlacklistuuid | 현재 워크스페이스에서 삭제되지 않은 규칙이 하나도 일치하지 않음(빈 배열 포함) | 블랙리스트가 존재하지 않음 | UUID와 워크스페이스를 확인한 후 다시 내보냅니다. |
| 500 | ft.InternalServerError | 규칙 조회, 내보내기 구성 또는 응답 형식 지정 실패 | 내부 오류 | 조회 조건과 UUID를 확인한 후 재시도합니다. 계속 실패하면 traceId를 제공합니다. |
| 403 | ft.Forbidden | API Key에 해당 작업 권한이 없거나 워크스페이스 버전이 블랙리스트 기능을 지원하지 않음 | 작업 권한이 없습니다. | 해당 권한이 있는 API Key와 이 기능을 지원하는 워크스페이스를 사용합니다. |