Skip to content

Log Indexes Available for Data Forwarding



GET /api/v1/log_backup_cfg/index_options/list

Overview

Retrieves the log indexes available for forwarding in the current workspace and the two-field protocol capabilities.

Prerequisites and Usage Steps

No Body or Query is required. items contains the default index and active internal regular/native direct-write indexes available for forwarding. Cloning requires Source A to be active and meet the conditions for a regular internal source; externally bound and query-type indexes are not included in the catalog. Sorted by name and type; counts are aggregated by the two categories.

Use items[].name to construct extend.indexs or regularLogIndexNames; do not use uuid. content.capabilities.forwardingIndexSelection.targets lists the target + format combinations that support the new log index selection. It does not mean that all dataType values support all targets; OpenAPI excludes Iceberg and TiDB. The catalog changes with start/stop/deletion; refresh before saving.

Request Headers

Parameter Type Required Description
DF-API-KEY string Y OpenAPI authentication credential for the workspace.
Example: <DF-API-KEY>
How to obtain or enter: Obtain an OpenAPI Key with the required permissions from API Key Management in the target workspace.

Additional Parameter Notes

Returns the candidate indexes, category counts, and forwarding targets and formats supported when creating rules through OpenAPI in the current workspace (excluding Iceberg and TiDB). The candidate items are a flat list. For multi-path sub-indexes, type is log, and sourceIndexUUID points to the parent index in the same list. Category counts include sub-indexes that can be selected independently. When submitting a rule, use the sub-index's own name.

Request Example

curl --get 'https://openapi.guance.com/api/v1/log_backup_cfg/index_options/list' \
  -H 'DF-API-KEY: <DF-API-KEY>'

Response

HTTP 200, application/json. The example below shows the main fields that can be read directly.

Field Type Description
content.items array<object> Array of selectable items.
content.items[].uuid string Index configuration UUID or default; used for display association.
content.items[].name string Actual name used when requesting index selection.
content.items[].type string native direct-write or log regular.
content.items[].sourceIndexUUID string Source A UUID for cloned items; omitted for non-cloned items.
content.counts.all integer Number of all candidates.
content.counts.native integer Number of direct-write candidates.
content.counts.log integer Number of regular candidates.
content.capabilities.forwardingIndexSelection.version integer Two-field selection protocol version; currently 1.
content.capabilities.forwardingIndexSelection.targets array<object> Target/format combinations that allow the new log index selection.
content.capabilities.forwardingIndexSelection.targets[].storeType string Target type; an empty string indicates the site default.
content.capabilities.forwardingIndexSelection.targets[].storageFormat string json/parquet, or an empty format for Kafka/LogBamboo.
content.declaration object Common declaration.
{
  "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"
}

Error Response

For authentication, rate limiting, and common request errors, see Common Error Definitions.

HTTP Status errorCode Trigger Condition Message or Response Description Handling
500 ft.InternalServerError Failed to read the configuration, identity information, cache, or response formatting Internal error Check the query parameters; if the failure persists, provide the traceId.

Feedback

Is this page helpful?