목록¶
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 | 페이지당 반환 개수; pageIndex와 함께 전달 시 데이터베이스 페이지네이션 활성화 $minValue: 1 $maxValue: 100 |
매개변수 추가 설명¶
응답 본문 구조 설명
| 매개변수명 | 유형 | 설명 |
|---|---|---|
| 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"
}