Modify Binding Index Configuration¶
POST /api/v1/external_log_index_cfg/{cfg_uuid}/modify
Overview¶
Modify a custom storage binding index configuration
Route Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| cfg_uuid | string | Y | Configuration uuid |
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| extend | json | Frontend custom data Allow empty: True |
|
| exterStoreName | string | Y | The name of the external storage that maps to the name (SLS type corresponds to StoreName, Volcengine's TLS corresponds to topic_name) Allow empty: False |
| name | string | Y | Index name Example: xxx Allow empty: False |
| exterStoreProject | string | The project corresponding to the external storage index (SLS type corresponds to StoreProject, Volcengine's TLS corresponds to project_name) Allow empty: False |
|
| region | string | Specifies the region of the external resource Allow empty: False |
|
| isPublicNetworkAccess | boolean | Whether public network access is allowed, effective when storeType is sls, default is False (added in 2024-07-10 iteration) Allow empty: True |
|
| accessCfg | json | Y | External resource access configuration information Allow empty: False |
| accessCfg.cloudAccountId | string | Cloud account ID Allow empty: False |
|
| accessCfg.ak | string | Secret key Id Allow empty: False |
|
| accessCfg.sk | string | Secret key Allow empty: False |
|
| accessCfg.url | string | URL address Allow empty: False |
|
| accessCfg.username | string | Username Allow empty: False Allow empty string: True |
|
| accessCfg.password | string | Password Allow empty: False Allow empty string: True |
|
| accessCfg.iamProjectName | string | Volcengine TLS iam_project_name Allow empty: False Allow empty string: True |
|
| accessCfg.iamProjectDisplayName | string | Display name of Volcengine TLS iam_project_name Allow empty: False Allow empty string: True |
|
| accessCfg.projectId | string | Volcengine TLS project_id Allow empty: False Allow empty string: True |
|
| accessCfg.topicId | string | Volcengine TLS topic_id Allow empty: False Allow empty string: True |
|
| fields | array | List of field mapping configurations to be updated Allow empty: False |
|
| fields[*] | None | ||
| fields[*].field | string | Y | Field name Example: message Allow empty: False |
| fields[*].originalField | string | Y | Original field name Example: content Allow empty: False Allow empty string: True |
Parameter Supplementary Explanation¶
Request Example¶
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