데이터 전송 시 선택 가능한 로그 인덱스¶
GET /api/v1/log_backup_cfg/index_options/list
개요¶
현재 워크스페이스에서 데이터 전송에 선택 가능한 로그 인덱스 및 듀얼 필드 프로토콜 기능을 가져옵니다.
호출 전 및 사용 단계¶
Body 또는 Query는 필요하지 않습니다. items에는 기본 인덱스와 데이터 전송에 사용할 수 있는 활성 내부 일반/네이티브 직접 쓰기 인덱스가 포함됩니다. 복제는 소스 A가 활성 상태이고 일반 내부 소스 조건을 충족해야 합니다. 외부 바인딩 및 쿼리형 인덱스는 카탈로그에 포함되지 않습니다. 이름 및 type 기준으로 정렬되며, counts는 두 가지 범주로 집계됩니다.
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 | 듀얼 필드 선택 프로토콜 버전이며 현재 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 | 구성, 신원 정보, 캐시 또는 응답 형식화 읽기 실패 | 내부 오류 | 쿼리 매개변수를 확인하고, 계속 실패하면 traceId를 제공하십시오. |