バインド済みインデックス設定の変更¶
POST /api/v1/external_log_index_cfg/{cfg_uuid}/modify
概要¶
バインド済みインデックスの設定を変更します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | Y | 設定 UUID |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| extend | json | フロントエンドカスタムデータ 空を許可: True |
|
| exterStoreName | string | Y | name と相互にマッピングされる外部ストレージの名前（SLS タイプの場合は StoreName、Volcengine TLS の場合は topic_name） 空を許可: False |
| name | string | Y | インデックス名 例: xxx 空を許可: False |
| desc | string | インデックスの説明 例: xxx 空を許可: False 空文字列を許可: True |
|
| 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.cloudAccountId | string | クラウドアカウント ID 空を許可: False |
|
| accessCfg.ak | string | アクセスキー ID 空を許可: False |
|
| accessCfg.sk | string | シークレットキー 空を許可: False |
|
| accessCfg.url | string | 接続アドレス 空を許可: False |
|
| accessCfg.username | string | ユーザー名 空を許可: False 空文字列を許可: True |
|
| accessCfg.password | string | パスワード 空を許可: False 空文字列を許可: True |
|
| 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/external_log_index_cfg/lgim_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accessCfg":{"url":"aabb.com","username":"test33"},"exterStoreName":"aa_uuid","fields":[{"field":"time","originalField":"time"},{"field":"__docid","originalField":"__docid"},{"field":"message","originalField":"message"}]}' \
--compressed