一覧表示¶
GET /api/v1/log_index_cfg/list
概要¶
ログインデックスの情報を一覧表示します。作成されたインデックスとバインドされたインデックスが含まれます。
インデックスの isBindCustomStore 属性値が 1 の場合、バインドされたインデックスを示します。
Query リクエストパラメーター¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| targetWorkspaceUUID | string | ターゲットワークスペース |
|
| isBindCustomStore | boolean | カスタムストレージにバインドするかどうか |
|
| queryType | commaArray | ストレージクエリタイプ |
|
| isDirectIndex | boolean | ネイティブダイレクトライトインデックスかどうか |
|
| search | string | インデックス名で検索 空文字列を許可: True |
|
| orderBy | string | 名前で昇順；未指定時は sortNo で降順 選択可能な値: ['name'] |
|
| pageIndex | integer | ページ番号；pageSize と同時に指定するとデータベースページネーションが有効になります $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却数；pageIndex と同時に指定するとデータベースページネーションが有効になります $minValue: 1 $maxValue: 100 |
パラメーター補足説明¶
レスポンス本文の構造説明
| パラメーター名 | type | 説明 |
|---|---|---|
| isBindCustomStore | int | 1: カスタムストレージにバインドされたインデックス設定 0: デフォルト |
| storeType | string | ストレージタイプ ('es': Elasticsearch ストレージ, 'sls': SLS Logstore ストレージ, 'opensearch': OpenSearch ストレージ, 'beaver': ログイーストレージ, 'clickhouse': ClickHouse ストレージ) |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/log_index_cfg/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
レスポンス¶
{
"code": 200,
"content": [
{
"conditions": "{ source in [ 'mysql' ] }",
"createAt": 1677571213,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"deleteAt": -1,
"duration": "14d",
"extend": {
"filters": [
{
"condition": "and",
"name": "source",
"operation": "in",
"value": [
"mysql"
]
}
]
},
"exterStoreName": "",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "",
"id": 5,
"isBindCustomStore": 0,
"isPublicNetworkAccess": 0,
"name": "no_1",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 4,
"status": 0,
"storeType": "",
"updateAt": 1677571213,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgim_xxxd2e",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "{ source in [ 'df_diagnose' ] }",
"createAt": 1677566168,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"deleteAt": -1,
"duration": "7d",
"extend": {
"filters": [
{
"condition": "and",
"name": "source",
"operation": "in",
"value": [
"df_diagnose"
]
}
]
},
"exterStoreName": "",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "",
"id": 4,
"isBindCustomStore": 0,
"isPublicNetworkAccess": 0,
"name": "datakit",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 3,
"status": 0,
"storeType": "",
"updateAt": 1677566168,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgim_xxxe03",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "",
"createAt": 1677489543,
"creator": "xx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"deleteAt": -1,
"duration": "",
"extend": {},
"exterStoreName": "s",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "erac_xxx1ed",
"id": 1,
"isBindCustomStore": 1,
"isPublicNetworkAccess": 1,
"name": "s",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 0,
"status": 0,
"storeType": "es",
"updateAt": 1677489543,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgim_xxxdaf",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "",
"createAt": 1677665779,
"creator": "xxx",
"creatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"deleteAt": -1,
"duration": "",
"extend": {},
"exterStoreName": "aa_uuid",
"exterStoreProject": "",
"externalResourceAccessCfgUUID": "erac_xxx8c5",
"id": 12,
"isBindCustomStore": 1,
"isPublicNetworkAccess": 1,
"name": "openapi_test",
"queryType": "logging",
"region": "",
"setting": {},
"sortNo": 0,
"status": 0,
"storeType": "es",
"updateAt": 1677665779,
"updator": "xx",
"updatorInfo": {
"uuid": "xx",
"status": 0,
"username": "xx",
"name": "xx",
"iconUrl": "",
"email": "xx",
"acntWsNickname": "xx"
},
"uuid": "lgim_xxx141",
"workspaceUUID": "wksp_xxx115"
},
{
"conditions": "",
"duration": "14d",
"extend": {},
"isBindCustomStore": false,
"name": "default",
"queryType": "logging",
"sortNo": -1,
"uuid": "default",
"workspaceUUID": "wksp_xxx115"
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-2EB09DB4-7D3C-4DA5-9054-81856CC0589D"
}