워크스페이스-인덱스 정보 목록 조회¶
GET /api/v1/workspace/{workspace_uuid}/index_list_info
개요¶
지정한 워크스페이스의 스토리지 엔진, 기본 인덱스 템플릿 및 로그 인덱스 구성을 읽습니다.
호출 전 및 사용 단계¶
워크스페이스 목록에서 UUID를 가져옵니다. 먼저 datastore로 각 데이터 유형에서 사용하는 엔진을 확인한 다음 durationSet, storagePolicy 및 esIndexSettings를 확인합니다. 구성 키는 워크스페이스, 엔진 및 버전에 따라 달라집니다. otherLogIndexSettings에는 삭제되지 않았고 사용자 지정 스토리지에 바인딩되지 않은 로그 인덱스만 포함됩니다.
DF_EXTERNAL_API_URL, DF_EXTERNAL_ACCESS_KEY, DF_EXTERNAL_SECRET_KEY를 설정한 후 예시를 실행합니다. 예시의 워크스페이스 UUID, 브랜드 및 구성 값을 실제 값으로 바꾸며, 서명 버전은 v20240417입니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| workspace_uuid | string | Y | 대상 사이트의 유효한 워크스페이스 UUID를 사용해야 합니다. null 허용: False 예시: wksp_example가져오기 또는 입력 방법: 워크스페이스 목록의 content.data[].uuid에서 가져옵니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| X-Df-SVersion | string | 서명 버전이며, 아래 예시에서는 v20240417을 사용합니다. 예시: v20240417가져오기 또는 입력 방법: 서명 알고리즘에 맞게 예시와 동일하게 입력합니다. |
|
| X-Df-Access-Key | string | Y | 요청 AK 정보입니다. 예시: <access-key>가져오기 또는 입력 방법: External API 관리자가 할당합니다. |
| X-Df-Signature | string | Y | 서명 정보입니다. 예시: <hex-signature>가져오기 또는 입력 방법: 예시에 따라 메서드, nonce, 경로, 타임스탬프 및 빈 문자열에 대해 HMAC-SHA256을 계산합니다. |
| X-Df-Timestamp | string | Y | 요청 시의 타임스탬프입니다. 예시: 1785456000가져오기 또는 입력 방법: 호출 시점의 현재 Unix 초를 입력합니다. 예: date +%s 실행. |
| X-Df-Nonce | string | Y | 요청 시 생성하는 임시 코드입니다. 예시: b53b47e12e514616ad8cb1f17cb66dce가져오기 또는 입력 방법: 매 요청마다 새로운 임의 값을 생성합니다. 예: uuid.uuid4().hex. |
파라미터 추가 설명¶
아래 예시는 로그 관련 구성 일부를 발췌한 것입니다. 엔진에 따라 템플릿 내용이 다를 수 있습니다.
요청 예시¶
import hmac
import json
import os
import time
import uuid
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/wksp_example/index_list_info"
method = "GET"
body = b''
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = f"{method} {nonce} {path} {timestamp} ".encode("utf-8") + body
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload, "sha256").hex()
headers = {
"X-Df-Access-Key": os.environ["DF_EXTERNAL_ACCESS_KEY"],
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-SVersion": "v20240417",
"X-Df-Signature": signature,
}
response = requests.request(method, server + path, headers=headers, data=body, timeout=15)
response.raise_for_status()
data = response.json()["content"]
응답¶
HTTP 200, application/json.
| 필드 | 유형 | 설명 |
|---|---|---|
| content.datastore | object | 데이터 유형별로 구성된 스토리지 엔진입니다. 예: logging: doris. |
| content.durationSet | object | 유형별로 구성된 보존 기간입니다. 일반적인 형식은 일수에 d를 붙인 형태입니다(예: 7d). |
| content.storagePolicy | object | 데이터 유형별로 구성된 워크스페이스 수준 스토리지 정책 구성입니다. |
| content.esIndexSettings | object | 각 데이터 유형의 인덱스 템플릿 구성이며, 해당 워크스페이스의 사용자 지정 설정으로 기본 템플릿을 덮어씁니다. |
| content.esIndexMerged | integer | ES 등 엔진에서 워크스페이스별로 인덱스를 병합하는지 여부입니다. 1은 병합, 0은 병합하지 않음을 의미합니다. |
| content.otherLogIndexSettings | array<object> |
워크스페이스에서 개별 구성된 로그 인덱스 정보입니다. 조건을 충족하는 인덱스가 없으면 빈 배열입니다. |
| content.otherLogIndexSettings[].uuid | string | 로그 인덱스 식별자입니다. |
| content.otherLogIndexSettings[].name | string | 로그 인덱스 이름입니다. |
| content.otherLogIndexSettings[].setting | object 또는 null | 개별 인덱스의 구성입니다. 명시적으로 구성하지 않은 경우 기본 템플릿을 사용할 수 있습니다. |
| content.otherLogIndexSettings[].duration | string | 해당 로그 인덱스의 보존 기간입니다. |
| content.otherLogIndexSettings[].storagePolicy | object | 개별 로그 인덱스의 스토리지 정책이며, 구성하지 않은 경우 {}입니다. |
{
"code": 200,
"content": {
"datastore": {
"logging": "sls"
},
"durationSet": {
"logging": "7d",
"resource_map": "7d"
},
"storagePolicy": {},
"esIndexSettings": {
"logging": {
"storagePolicy": {}
}
},
"esIndexMerged": 0,
"otherLogIndexSettings": [
{
"uuid": "lgim_example",
"name": "application",
"setting": {},
"duration": "7d",
"storagePolicy": {}
}
]
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.NotFoundWorkspace | 워크스페이스가 존재하지 않거나 상태가 유효한 상태가 아님 | 지정한 워크스페이스를 찾을 수 없습니다. | 대상 사이트와 워크스페이스 UUID를 확인하세요. |
| 404 | ft.NamespaceDatastoreNotFound | 인덱스 템플릿과 연결된 데이터 유형에 스토리지 엔진이 구성되지 않음 | 해당 데이터 유형의 스토리지 유형을 찾을 수 없습니다. | 관리자에게 해당 워크스페이스의 데이터 스토리지 구성을 확인하도록 요청하세요. |