Create a single binding index configuration¶
POST /api/v1/log_index_cfg/bind
Overview¶
Create a custom storage binding index
Body Request Parameters¶
Parameter Name | Type | Required | Description |
---|---|---|---|
extend | json | Frontend custom data Can be empty: True |
|
name | string | Y | Index name Example: xxx Can be empty: False |
storeType | string | Y | Storage type Example: xxx Can be empty: False |
exterStoreName | string | Y | Externally mapped storage name corresponding to name (SLS type corresponds to StoreName, Volcengine's TLS corresponds to topic_name) 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 external resources Can be empty: False |
|
isPublicNetworkAccess | boolean | Whether public network access, 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.ak | string | Key Id Can be empty: False |
|
accessCfg.sk | string | Key Can be empty: False |
|
accessCfg.url | string | URL address Can be empty: False |
|
accessCfg.username | string | Username Can be empty: False |
|
accessCfg.password | string | Password Can be empty: False |
|
accessCfg.iamProjectName | string | Volcengine TLS iam_project_name Can be empty: False Can be an empty string: True |
|
accessCfg.iamProjectDisplayName | string | Display name of 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 update 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/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