콘텐츠로 이동

목록 조회



GET /api/v1/log_index_cfg/list

개요

워크스페이스의 로그 인덱스 설정을 나열하며, 인덱스 유형 및 이름으로 필터링할 수 있습니다.

호출 전 및 사용 단계

페이지네이션 파라미터를 전달하지 않으면 인덱스 레코드는 content 배열에 있습니다. pageIndex와 pageSize를 모두 전달하면 인덱스 레코드는 content.data에 있으며, 페이지네이션 정보는 최상위 pageInfo에 위치합니다. 기본적으로 이름 오름차순으로 정렬되며, 기본 인덱스는 쿼리 범위에 따라 처음 또는 끝에 나타날 수 있습니다. 대상 워크스페이스를 생략하면 현재 워크스페이스를 쿼리합니다. 워크스페이스 간에는 현재 워크스페이스에 유효한 로그 권한이 있는 인덱스만 반환합니다. queryType을 사용하면 API Key 데이터 액세스 규칙에 의해서도 필터링됩니다. 이름이 같은 워크스페이스 간 인덱스는 하나로 병합될 수 있습니다.

요청 헤더

파라미터명 유형 필수 설명
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~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 페이지당 건수입니다.
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이 아님 또는 선언되지 않은 파라미터 전달 요청 필드 검증에 실패했습니다. 쿼리 파라미터를 확인하고, 페이지네이션은 양의 정수를 사용하며 두 페이지네이션 파라미터를 동시에 전달하십시오.

문서 평가

이 페이지가 도움이 되었나요?