ワークスペース - インデックス情報リストの取得¶
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 | インデックステンプレートに関連付けられたデータタイプにストレージエンジンが設定されていない | 該当するデータタイプのストレージタイプが見つかりません。 | 管理者にこのワークスペースのデータストレージ設定を確認してもらってください。 |