一覧¶
GET /api/v1/log_index_cfg/list
概要¶
ワークスペースのログインデックス設定を一覧表示します。インデックスタイプと名前でフィルタリングできます。
呼び出し前の確認事項と使用手順¶
ページネーションパラメータを指定しない場合、インデックスレコードは content 配列に格納されます。pageIndex と pageSize の両方を指定した場合、インデックスレコードは content.data に格納され、ページネーション情報はトップレベルの pageInfo に配置されます。デフォルトでは名前の昇順で並び、デフォルトインデックスはクエリ範囲によって先頭または末尾に表示される場合があります。対象ワークスペースを省略した場合は現在のワークスペースをクエリします。クロスワークスペースでは、現在のワークスペースに対して有効なログ権限を持つインデックスのみが返されます。queryType を使用する場合、API Key のデータアクセスルールによるフィルタリングも適用されます。同名のクロスワークスペースインデックスは 1 件に統合される場合があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの呼び出し資格情報。レコード UUID と呼び出し資格情報は異なるフィールドです。 例: <DF-API-KEY>取得または入力方法: 現在のワークスペースの API Key 管理から完全な資格情報を取得します。 |
クエリリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| targetWorkspaceUUID | string | 対象ワークスペース。* を指定すると、現在のサイトでアクセス権限を付与できるワークスペースをクエリできます。 例: wksp_example取得または入力方法: 権限付与元のワークスペース詳細から UUID を取得します。現在のワークスペースの場合は省略できます。 |
|
| isBindCustomStore | boolean | 省略した場合、バインド状態によるフィルタリングは行いません。 例: false取得または入力方法: true を指定するとカスタムストレージにバインドされたインデックスを一覧表示し、false を指定すると通常のインデックスを一覧表示します。 |
|
| queryType | commaArray | クエリ方式でフィルタリングします。logging は組み込みログおよび大多数の非 SLS インデックスに使用します。standard と query はそれぞれ SLS の時系列クラスとログクラスのクエリに使用します。明示的にフィルタリングする場合は、デフォルトインデックスを一覧表示できるように logging を含める必要があります。 例: logging,standard取得または入力方法: 本インターフェースの既存レコードの queryType からインデックスタイプを取得し、複数の値は半角カンマで隙間なく連結します。 |
|
| isDirectIndex | boolean | 省略した場合、ダイレクト書き込み状態によるフィルタリングは行いません。 例: false取得または入力方法: ネイティブのダイレクト書き込みインデックスをクエリするかどうかに応じて true または false を入力します。 |
|
| search | string | 大文字と小文字を区別しない名前の部分一致です。 空文字列を許可: True 例: access取得または入力方法: ログインデックス名またはその一部を入力します。 |
|
| orderBy | string | 並べ替えフィールドは name のみをサポートし、デフォルトでは名前の昇順です。 指定可能な値: ['name'] 例: name取得または入力方法: 省略するか、name を指定します。 |
|
| pageIndex | integer | ページ番号。最小値は 1 です。 $minValue: 1 例: 1取得または入力方法: ページネーションを有効にする場合は pageSize も同時に指定し、1 から開始します。 |
|
| pageSize | integer | 1 ページあたり 1~100 件です。 $minValue: 1 $maxValue: 100 例: 20取得または入力方法: ページネーションを有効にする場合は pageIndex も同時に指定します。 |
パラメータ補足説明¶
例に示すリソース識別子はプレースホルダー値です。対象ワークスペースの実際の値に置き換えてください。
リクエスト例¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/log_index_cfg/list' \
--data-urlencode "queryType=logging,standard" \
--data-urlencode "pageIndex=1" \
--data-urlencode "pageSize=20"
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object または array<object> |
ページネーションなしの場合はインデックス配列、ページネーションありの場合は data を含むオブジェクトです。 |
| content.data | array<object> |
ページネーション時のインデックスレコードです。 |
| content[].uuid または content.data[].uuid | string | インデックス設定の識別子です。通常の行はインデックス詳細の取得に使用し、デフォルトインデックスでは default を使用します。 |
| content[].name または content.data[].name | string | ログインデックス名です。 |
| content[].workspaceUUID または content.data[].workspaceUUID | string | インデックスが属するワークスペースです。 |
| content[].duration または content.data[].duration | string | ログの保持期間(例: 14d)。外部ストレージにバインドされたインデックスの場合は空になることがあります。 |
| content[].isBindCustomStore または content.data[].isBindCustomStore | integer または boolean | 外部ストレージにバインドされている場合は 1、通常のマネージドインデックスの場合は 0 です。デフォルト行では false が返されることがあります。 |
| content[].queryType または content.data[].queryType | string | インデックスがサポートするクエリタイプです。 |
| content[].directIndex または content.data[].directIndex | integer | 通常のインデックスのネイティブダイレクト書き込みフラグです。1 は該当、0 は非該当を表します。デフォルトインデックスでは省略されることがあります。 |
| content[].sortNo または content.data[].sortNo | string または integer | インデックス設定で並べ替えに使用される値です。デフォルトインデックスでは -1 になることがあります。 |
| content[].storeType または content.data[].storeType | string | インデックスに関連付けられたストレージタイプです。デフォルトインデックスでは省略されることがあります。 |
| content.declaration | object または null | ページネーション時のワークスペース宣言です。ページネーションなしの場合は単一レコード上に現れることがあります。 |
| content.cloneTotal | integer | データベースページネーションの分岐では、クローンインデックス数を返すことがあります。 |
| content.physicalTotal | integer | データベースページネーションの分岐では、物理インデックス数を返すことがあります。 |
| pageInfo | object | ページネーション結果の外側のページネーションオブジェクトです。 |
| pageInfo.pageIndex | integer | 現在のページ番号です。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数です。 |
| pageInfo.count | integer | このページの件数です。 |
| pageInfo.totalCount | integer | 表示可能かつ条件を満たす総件数です。 |
{
"code": 200,
"content": {
"data": [
{
"uuid": "default",
"name": "default",
"workspaceUUID": "wksp_example",
"duration": "14d",
"isBindCustomStore": false,
"queryType": "logging",
"sortNo": -1
}
],
"declaration": null,
"cloneTotal": 0,
"physicalTotal": 0
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
ページネーションなしのリクエストのレスポンス例
{
"code": 200,
"content": [
{
"uuid": "default",
"name": "default",
"workspaceUUID": "wksp_example",
"duration": "14d",
"isBindCustomStore": false,
"queryType": "logging",
"sortNo": -1,
"declaration": null
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | ページネーションが許容範囲外、orderBy が name 以外、または宣言されていないパラメータが渡された場合 | リクエストフィールドの検証に失敗しました。 | クエリパラメータを確認し、ページネーションには正の整数を使用して、2 つのページネーションパラメータを同時に指定してください。 |