データ転送で選択可能なログインデックス¶
GET /api/v1/log_backup_cfg/index_options/list
概要¶
現在のワークスペースでデータ転送に選択可能なログインデックスと、2 フィールドプロトコル機能を取得します。
呼び出し前の準備と使用手順¶
Body または Query は不要です。items にはデフォルトインデックス、および転送に使用可能なアクティブな内部通常/ネイティブ直接書き込みインデックスが含まれます。クローンには、ソース A がアクティブであり、通常の内部ソース条件を満たすことが必要です。外部バインディングとクエリ型インデックスはカタログに含まれません。名前と type でソートされ、counts は 2 種類で集計されます。
items[].name を使用して extend.indexs または regularLogIndexNames を構築し、uuid は使用しません。content.capabilities.forwardingIndexSelection.targets には、新しいバージョンのログインデックス選択をサポートするターゲット + 形式の組み合わせが表示されますが、すべての dataType がすべてのターゲットをサポートするわけではありません。OpenAPI では Iceberg と TiDB が除外されます。カタログは有効化/停止/削除に伴って変化するため、保存前に更新してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
現在のワークスペースの候補インデックス、分類カウント、および OpenAPI のルール作成でサポートされる転送ターゲットと形式(Iceberg と TiDB を除く)を返します。
候補 items はフラットリストで、複数経路の子インデックスの type は log であり、sourceIndexUUID は同じリスト内の親インデックスを指します。
分類カウントには、独立して選択可能な子インデックスが含まれます。ルールを送信するときは、子インデックス自身の名前を使用します。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/index_options/list' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.items | array<object> |
選択可能な項目の配列。 |
| content.items[].uuid | string | インデックス設定 UUID または default。関連付けの表示用。 |
| content.items[].name | string | インデックス選択のリクエストで使用する実際の名前。 |
| content.items[].type | string | native は直接書き込み、log は通常。 |
| content.items[].sourceIndexUUID | string | クローン項目のソース A の UUID。クローンでない場合は省略。 |
| content.counts.all | integer | すべての候補数。 |
| content.counts.native | integer | 直接書き込みの候補数。 |
| content.counts.log | integer | 通常の候補数。 |
| content.capabilities.forwardingIndexSelection.version | integer | 2 フィールド選択プロトコルのバージョン。現在は 1。 |
| content.capabilities.forwardingIndexSelection.targets | array<object> |
新しいバージョンのログインデックス選択で許可されるターゲット/形式の組み合わせ。 |
| content.capabilities.forwardingIndexSelection.targets[].storeType | string | ターゲット種別。空文字列はサイトのデフォルトを表します。 |
| content.capabilities.forwardingIndexSelection.targets[].storageFormat | string | json/parquet、または Kafka/LogBamboo の空形式。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"items": [
{
"uuid": "default",
"type": "log",
"name": "default"
},
{
"uuid": "lgim_example",
"type": "log",
"name": "production_logs"
}
],
"counts": {
"all": 2,
"native": 0,
"log": 2
},
"capabilities": {
"forwardingIndexSelection": {
"version": 1,
"targets": [
{
"storeType": "",
"storageFormat": "json"
},
{
"storeType": "doris",
"storageFormat": "json"
},
{
"storeType": "gcs",
"storageFormat": "json"
},
{
"storeType": "gcs",
"storageFormat": "parquet"
},
{
"storeType": "guanceObject",
"storageFormat": "json"
},
{
"storeType": "kafka",
"storageFormat": ""
},
{
"storeType": "logbamboo",
"storageFormat": ""
},
{
"storeType": "obs",
"storageFormat": "json"
},
{
"storeType": "obs",
"storageFormat": "parquet"
},
{
"storeType": "oss",
"storageFormat": "json"
},
{
"storeType": "oss",
"storageFormat": "parquet"
},
{
"storeType": "s3",
"storageFormat": "json"
},
{
"storeType": "s3",
"storageFormat": "parquet"
},
{
"storeType": "tos",
"storageFormat": "json"
},
{
"storeType": "tos",
"storageFormat": "parquet"
}
]
}
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 設定、ID 情報、キャッシュ、またはレスポンスのフォーマット読み取りに失敗 | 内部エラー | クエリパラメータを確認し、継続して失敗する場合は traceId を提供してください。 |