コンテンツにスキップ

インデックス情報の取得¶

GET /api/v1/log_index_cfg/{cfg_uuid}/get

概要¶

バインドされたインデックス設定の詳細情報を取得します。

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
cfg_uuid	string	Y	ログインデックス設定の UUID

Query リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
isShowAccessCfg	boolean		accessCfg を表示するかどうか
isShowFields	boolean		fields リストを表示するかどうか

パラメータ補足説明¶

レスポンス本文の構造説明

パラメータ名	type	説明
isBindCustomStore	int	1: カスタムストレージにバインドされたインデックス設定、0: デフォルト
storeType	string	ストレージタイプ（'es': Elasticsearch ストレージ、'sls': SLS Logstore ストレージ、'opensearch': OpenSearch ストレージ、'beaver': ログイーストレージ、'clickhouse': ClickHouse ストレージ）
fields	array	フィールドマッピング設定
accessCfg	array	カスタムストレージインデックスのアクセス権限設定項目

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/log_index_cfg/lgim_xxxx32/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "conditions": "",
        "createAt": 1677665779,
        "creator": "xxx",
        "deleteAt": -1,
        "duration": "",
        "extend": {},
        "exterStoreName": "aa_uuid",
        "exterStoreProject": "",
        "externalResourceAccessCfgUUID": "erac_xxxx32",
        "id": 12,
        "isBindCustomStore": 1,
        "isPublicNetworkAccess": 1,
        "name": "openapi_test",
        "queryType": "logging",
        "region": "",
        "regionInfo": {},
        "setting": {},
        "sortNo": 0,
        "status": 0,
        "storeType": "es",
        "updateAt": 1677665779,
        "updator": "xxx",
        "uuid": "lgim_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-82BF8659-CD28-409B-833B-97AA4758ACA1"
}