Skip to content

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
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	External storage name corresponding to `name` (SLS type corresponds to StoreName, Volcano Cloud's TLS corresponds to topic_name) Can be empty: False
exterStoreProject	string		Project corresponding to the external storage index (SLS type corresponds to StoreProject, Volcano Cloud'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.ak	string		Access Key ID Can be empty: False
accessCfg.sk	string		Secret Key Can be empty: False
accessCfg.url	string		URL Can be empty: False
accessCfg.username	string		Username Can be empty: False
accessCfg.password	string		Password Can be empty: False
accessCfg.iamProjectName	string		Volcano Cloud TLS's iam_project_name Can be empty: False Can be an empty string: True
accessCfg.iamProjectDisplayName	string		Display name for Volcano Cloud TLS's iam_project_name Can be empty: False Can be an empty string: True
accessCfg.projectId	string		Volcano Cloud TLS project_id Can be empty: False Can be an empty string: True
accessCfg.topicId	string		Volcano Cloud 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

Response¶

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