コンテンツにスキップ

インデックスをバインド¶

POST /api/v1/log_index_cfg/bind

概要¶

外部インデックスをバインドします

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

パラメータ名	型	必須	説明
extend	json		フロントエンドカスタムデータ空を許可: True
name	string	Y	インデックス名例: xxx 空を許可: False
desc	string		インデックスの説明例: xxx 空を許可: False 空文字列を許可: True
storeType	string	Y	ストレージタイプ例: xxx 空を許可: False
exterStoreName	string	Y	name と相互にマッピングする外部ストレージの名前（SLS タイプは StoreName、Volcengine TLS は topic_name）空を許可: False
exterStoreProject	string		外部ストレージインデックスに対応する project（SLS タイプは StoreProject、Volcengine TLS は project_name）空を許可: False
region	string		外部リソースのリージョンを指定空を許可: False
isPublicNetworkAccess	boolean		パブリックネットワークアクセスかどうか。storeType が sls の場合に有効、デフォルトは False（2024-07-10 のイテレーションで追加）空を許可: True
accessCfg	json	Y	外部リソースのアクセス設定情報空を許可: False
accessCfg.ak	string		アクセスキーID 空を許可: False
accessCfg.sk	string		シークレットキー空を許可: False
accessCfg.url	string		接続 URL 空を許可: False
accessCfg.username	string		ユーザー名空を許可: False
accessCfg.password	string		パスワード空を許可: False
accessCfg.iamProjectName	string		Volcengine TLS の iam_project_name 空を許可: False 空文字列を許可: True
accessCfg.iamProjectDisplayName	string		Volcengine TLS の iam_project_name の表示名空を許可: False 空文字列を許可: True
accessCfg.projectId	string		Volcengine TLS の project_id 空を許可: False 空文字列を許可: True
accessCfg.topicId	string		Volcengine TLS の topic_id 空を許可: False 空文字列を許可: True
fields	array		更新するフィールドマッピング設定のリスト空を許可: False
fields[*]	None
fields[*].field	string	Y	フィールド名例: message 空を許可: False
fields[*].originalField	string	Y	元のフィールド名例: content 空を許可: False 空文字列を許可: True

パラメータ補足説明¶

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/log_index_cfg/bind' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-raw '{"accessCfg":{"url":"aa.com","password":"test","username":"test"},"exterStoreName":"aa_uuid","fields":[{"field":"time","originalField":"time"},{"field":"__docid","originalField":"__docid"},{"field":"message","originalField":"message"}],"storeType":"es","name":"openapi_test"}' \
  --compressed

レスポンス¶

{
    "code": 200,
    "content": true,
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-31E0802B-E53A-4D9B-8FD7-57A0CA4C2D66"
}