Modify Bound Index Configuration¶
POST /api/v1/external_log_index_cfg/{cfg_uuid}/modify
Overview¶
Modify a custom storage bound 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 | Front-end custom data Can be empty: True |
|
| exterStoreName | string | Y | The name of the external storage mapped to the name (SLS type corresponds to StoreName, Volcengine's TLS corresponds to topic_name) Can be empty: False |
| name | string | Y | Index name Example: xxx Can be empty: False |
| exterStoreProject | string | External storage index corresponding project (SLS type corresponds to StoreProject, Volcengine's TLS corresponds to project_name) Can be empty: False |
|
| region | string | Specify the region of the external resource Can be empty: False |
|
| isPublicNetworkAccess | boolean | Whether public network access is enabled, effective when storeType is sls, default is False (added in iteration on 2024-07-10) Can be empty: True |
|
| accessCfg | json | Y | External resource access configuration information Can be empty: False |
| accessCfg.cloudAccountId | string | Cloud account ID Can be empty: False |
|
| accessCfg.ak | string | Secret Key Id Can be empty: False |
|
| accessCfg.sk | string | Secret Key Can be empty: False |
|
| accessCfg.url | string | URL address Can be empty: False |
|
| accessCfg.username | string | Username Can be empty: False Can be an empty string: True |
|
| accessCfg.password | string | Password Can be empty: False Can be an empty string: True |
|
| accessCfg.iamProjectName | string | Volcengine TLS iam_project_name Can be empty: False Can be an empty string: True |
|
| accessCfg.iamProjectDisplayName | string | Display name for Volcengine TLS iam_project_name Can be empty: False Can be an empty string: True |
|
| accessCfg.projectId | string | Volcengine TLS project_id Can be empty: False Can be an empty string: True |
|
| accessCfg.topicId | string | Volcengine TLS topic_id Can be empty: False Can be an empty string: True |
|
| fields | array | List of field mapping configurations to be updated Can be empty: False |
|
| fields[*] | None | ||
| fields[*].field | string | Y | Field name Example: message Can be empty: False |
| fields[*].originalField | string | Y | Original field name Example: content Can be empty: False Can be an empty string: True |
Additional Parameter Notes¶
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