콘텐츠로 이동

인덱스 바인딩¶

POST /api/v1/log_index_cfg/bind

개요¶

외부 인덱스 바인딩

Body 요청 매개변수¶

매개변수명	유형	필수	설명
extend	json		프론트엔드 사용자 정의 데이터 빈 값 허용: True
name	string	Y	인덱스 이름 예시: xxx 빈 값 허용: False
desc	string		인덱스 설명 예시: xxx 빈 값 허용: False 빈 문자열 허용: True
storeType	string	Y	저장 유형 예시: xxx 빈 값 허용: False
exterStoreName	string	Y	name과 매핑되는 외부 저장소 이름(SLS 유형은 StoreName, Volcengine TLS는 topic_name에 해당) 빈 값 허용: False
exterStoreProject	string		외부 저장소 인덱스에 해당하는 프로젝트(SLS 유형은 StoreProject, Volcengine TLS는 project_name에 해당) 빈 값 허용: False
region	string		외부 리소스의 리전 지정 빈 값 허용: False
isPublicNetworkAccess	boolean		퍼블릭 네트워크 액세스 여부, storeType이 sls인 경우 적용, 기본값은 False(2024-07-10 업데이트에 추가됨) 빈 값 허용: True
accessCfg	json	Y	외부 리소스 액세스 구성 정보 빈 값 허용: False
accessCfg.ak	string		액세스 키 ID 빈 값 허용: False
accessCfg.sk	string		시크릿 키 빈 값 허용: False
accessCfg.url	string		연결 주소 빈 값 허용: False
accessCfg.username	string		사용자 이름 빈 값 허용: False
accessCfg.password	string		비밀번호 빈 값 허용: False
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/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

응답¶

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