日志分析型应用支持的开源API

Elasticsearch Serverless服务支持开源的API,本文介绍日志分析型应用支持的开源API URI和对应的Method。

注意事项

  • GET _cat/indicesGET {index} 等获取元信息的接口的返回结果可能与开源7.10版本ES不一致,后续会逐步优化。

  • 请谨慎使用本文列表之外的API接口。ES Serverless应用可能对部分未开放的API采用mock返回方式,返回结果非真实业务数据,例如 /_cluster/health/{index}/_ilm/explain/_xpack等。

Compact and aligned text (CAT) APIs

API URI

适用Method

/_cat/count

GET

/_cat/count/{index}

GET

/_cat/indices

GET

/_cat/indices/{index}

GET

Document APIs

API URI

适用Method

/_bulk

PUT、POST

/{index}/_bulk

PUT、POST

/{index}/_doc

POST

/{index}/_termvectors

POST、GET

/{index}/{type}

POST

/{index}/{type}/_bulk

PUT、POST

/{index}/{type}/_mtermvectors

POST、GET

Index APIs

API URI

适用Method

/_analyze

POST、GET

/_mapping

GET

/_mapping/{type}

PUT、POST

/_mappings

GET

/_mappings/{type}

PUT、POST

/_resolve/index/{name}

GET

/_settings

PUT、GET

/{index}

PUT、GET、HEAD、DELETE

/{index}/_analyze

POST、GET

/{index}/_mapping

GET

/{index}/_mapping/

PUT、POST

/{index}/_mapping/{type}

PUT、POST、HEAD

/{index}/_mappings

GET

/{index}/_mappings/

PUT、POST

/{index}/_mappings/{type}

PUT、POST

/{index}/_settings

PUT、GET

/{index}/{type}/_mapping

PUT、POST

/{index}/{type}/_mappings

PUT、POST

Search APIs

API URI

适用Method

/_async_search

POST

/_async_search/{id}

GET、DELETE

/_count

POST、GET

/_msearch

POST、GET

/_scripts/{id}

GET

/_search

POST、GET

/_search/scroll

POST、GET

/_search/scroll/{scroll_id}

POST、GET、DELETE

/_validate/query

POST、GET

/{index}/_async_search

POST

/{index}/_count

POST、GET

/{index}/_field_caps

POST、GET

/{index}/_msearch

POST、GET

/{index}/_search

POST、GET

/{index}/_validate/query

POST、GET

/{index}/{type}/_count

POST、GET

/{index}/{type}/_msearch

POST、GET

/{index}/{type}/_search

POST、GET

/{index}/{type}/_validate/query

POST、GET

支持的其他APIs

API URI

适用Method

/_tasks/{task_id}

GET

/_tasks/{task_id}/_cancel

POST

/_xpack/security/_authenticate

GET

/_xpack/security/privilege/

POST

/_xpack/security/user/_has_privileges

POST、GET

可白名单开放的APIs

如果您需要使用下表中的API,可以提交工单或通过ES Serverless用户群(钉钉群号:1120501767072335013004)联系客服添加白名单,请说明需要使用的API并描述使用场景。

API URI

Method

/_reindex

POST

/{index}/_update_by_query

POST

/{index}/{type}/_update_by_query

POST

/{index}/_delete_by_query

POST

/{index}/{type}/_delete_by_query

POST