Open source APIs supported by Serverless log analysis applications, APIs available through whitelisting, Elasticsearch Serverless service support-Elasticsearch(ES)-阿里云帮助中心

Elasticsearch Serverless supports open source APIs. This topic describes the API URIs and corresponding methods that are supported by log analysis applications.

Precautions

Results from API operations that retrieve metadata, such as GET _cat/indices and GET {index}, may be inconsistent with those from open source Elasticsearch 7.10. These inconsistencies will be resolved in future updates.
Use API operations not listed in this topic with caution. Elasticsearch Serverless applications may return mock data for certain unavailable API operations, such as /_cluster/health, /{index}/_ilm/explain, and /_xpack. The results returned are not actual business data.
Use asynchronous task APIs, such as Scroll, Async_search, and Task, with caution. These APIs may fail because of auto-scaling. Therefore, do not retain their task IDs for extended periods. If a task ID becomes invalid, submit a new request. Do not retry the original request.

Compact and aligned text (CAT) APIs

API URI	Applicable Method
/_cat/count	GET
/_cat/count/{index}	GET
/_cat/indices	GET
/_cat/indices/{index}	GET

Document APIs

API URI	Applicable 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	Applicable Method
/_analyze	POST, GET
/_aliases	POST, GET
/_aliases/{name}	PUT, POST
/_alias	PUT, GET
/_alias/{name}	PUT, POST, GET, HEAD
_component_template	GET
_component_template/{name}	PUT, POST, DELETE
/_component_template/{name}	GET, HEAD
/_mappings/{type}	PUT, POST
/_mapping	GET
/_mapping/{type}	PUT, POST
/_mappings	GET
/_resolve/index/{name}	GET
/{index}	PUT, GET, HEAD, DELETE
/{index}/_alias	PUT , GET, HEAD
/{index}/_alias/{name}	GET, HEAD
/<index>/_alias/<name>	PUT, POST, DELETE
/<index>/_aliases/<name>	PUT, POST, DELETE
/{index}/_analyze	POST, GET
/{index}/_aliases	PUT
/{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
/_index_template	GET
/_index_template/{name}	PUT, POST, GET, HEAD, DELETE
/_settings	PUT, GET
/_template	GET
/_template/{name}	PUT, POST, GET, HEAD, DELETE

Search APIs

API URI	Applicable 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

Other supported APIs

API URI	Applicable 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

If you have questions about the APIs in this topic, you can submit a ticket or contact us through the ES Serverless user group (DingTalk group number: 11205017670 or 72335013004). In your request, please specify the API that you need to use and describe your scenario.