数据转发可选日志索引¶
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。 |