Open source APIs supported by retrieval-enhanced applications-Elasticsearch(ES)-阿里云帮助中心

Alibaba Cloud Elasticsearch Serverless Service supports open source APIs. This topic describes the open source API URI and the corresponding Method for retrieval-enhanced applications (version 8.17).

Cluster APIs

API URI	Applicable Method
/_cluster/settings	GET
/_cluster/settings	PUT
/_tasks	GET
/_tasks/{task_id}	GET
/_tasks/_cancel	POST
/_tasks/{task_id}/_cancel	POST

Compact and aligned text (CAT) APIs

API URI	Applicable Method
/_cat/shards	GET
/_cat/shards/{index}	GET
/_cat/indices	GET
/_cat/indices/{index}	GET
/_cat/count	GET
/_cat/count/{index}	GET
/_cat/aliases	GET
/_cat/aliases/{alias}	GET
/_cat/fielddata	GET
/_cat/fielddata/{fields}	GET
/_cat/templates	GET
/_cat/templates/{name}	GET
/_cat/component_templates	GET
/_cat/component_templates/{name}	GET

Document APIs

API URI	Applicable Method
/{index}/_update/{id}	POST
/_bulk	PUT, POST
/{index}/_bulk	PUT, POST
/{index}/_doc/{id}	DELETE
/_mget	POST, GET
/{index}/_mget	POST, GET
/{index}/_source/{id}	GET, HEAD
/{index}/_doc/{id}	GET, HEAD
/{index}/_doc	POST
/{index}/_create/{id}	PUT, POST
/{index}/_doc/{id}	PUT, POST
/{index}/_update_by_query	POST
/_update_by_query/{taskId}/_rethrottle	POST
/{index}/_delete_by_query	POST
/_delete_by_query/{taskId}/_rethrottle	POST
/{index}/_termvectors	POST, GET
/{index}/_termvectors/{id}	POST, GET
/_mtermvectors	POST, GET
/{index}/_mtermvectors	POST, GET
/_reindex	POST
/_reindex/{taskId}/_rethrottle	POST

Index APIs

API URI	Applicable Method
/_resolve/index/{name}	GET
/_flush	POST, GET
/{index}/_flush	POST, GET
/_refresh	POST, GET
/{index}/_refresh	POST, GET
/_mapping	GET
/_mappings	GET
/{index}/_mapping	GET
/{index}/_mappings	GET
/_mapping/field/{fields}	GET
/{index}/_mapping/field/{fields}	GET
/{index}/_mapping/	PUT, POST
/{index}/_mappings/	PUT, POST
/_index_template/_simulate	POST
/_index_template/_simulate/{name}	POST
/_index_template/_simulate_index/{name}	POST
/_index_template/{name}	DELETE
/_index_template/{name}	GET, HEAD
/_index_template/{name}	PUT, POST
/_index_template	GET
/_component_template/{name}	DELETE
/_component_template/{name}	GET, HEAD
/_component_template/{name}	PUT, POST
/_component_template	GET
/_template/{name}	DELETE
/_template/{name}	GET, HEAD
/_template/{name}	PUT, POST
/_template	GET
/_settings	GET
/_settings/{name}	GET
/{index}/_settings	GET
/{index}/_settings/{name}	GET
/{index}/_setting/{name}	GET
/_settings	PUT
/{index}/_settings	PUT
/{index}	DELETE
/{index}	PUT
/{index}	GET, HEAD
/_aliases	POST
/_alias	PUT
/{index}/_aliases	PUT
/{index}/_alias	PUT
/_aliases/{name}	PUT, POST
/{index}/_aliases/{name}	PUT, POST
/_alias/{name}	PUT, POST
/{index}/_alias/{name}	PUT, POST
/{index}/_aliases/{name}	DELETE
/{index}/_alias/{name}	DELETE
/_aliases	GET
/_alias	GET
/_alias/{name}	GET, HEAD
/{index}/_alias	GET, HEAD
/{index}/_alias/{name}	GET, HEAD
/_stats	GET
/_stats/{metric}	GET
/{index}/_stats	GET
/{index}/_stats/{metric}	GET
/_analyze	POST, GET
/{index}/_analyze	POST, GET

Search APIs

API URI	Applicable Method
/{index}/_explain/{id}	POST, GET
/_msearch	POST, GET
/{index}/_msearch	POST, GET
/_search	POST, GET
/{index}/_search	POST, GET
/_count	POST, GET
/{index}/_count	POST, GET
/_async_search	POST
/{index}/_async_search	POST
/_async_search/{id}	GET
/_async_search/{id}	DELETE
/_async_search/status/{id}	GET
/_render/template	POST, GET
/_render/template/{id}	POST, GET
/_search/template	POST, GET
/{index}/_search/template	POST, GET
/_msearch/template	POST, GET
/{index}/_msearch/template	POST, GET
/_validate/query	POST, GET
/{index}/_validate/query	POST, GET
/_field_caps	POST, GET
/{index}/_field_caps	POST, GET
/{index}/_terms_enum	POST, GET
/_pit	POST
/_pit	DELETE
/{index}/_pit	POST
/_search/scroll/{scroll_id}	DELETE
/_search/scroll	DELETE
/_search/scroll/{scroll_id}	POST, GET
/_search/scroll	POST, GET

Script APIs

API URI	Applicable Method
/_scripts/{id}	DELETE
/_scripts/{id}/{context}	PUT, POST
/_scripts/{id}	PUT, POST
/_scripts/{id}	GET

Ingest APIs

API URI	Applicable Method
/_ingest/pipeline/_simulate	POST, GET
/_ingest/pipeline/{id}/_simulate	POST, GET
/_ingest/pipeline/{id}	DELETE
/_ingest/pipeline/{id}	GET
/_ingest/pipeline	GET
/_ingest/pipeline/{id}	PUT

Security APIs

API URI	Applicable Method
/_security/_authenticate	GET
/_security/user/_has_privileges	POST, GET
/_security/user/_privileges	GET
/_security/privilege/	GET
/_security/privilege/{application}	GET
/_security/privilege/{application}/{privilege}	GEt

Other supported APIs

API URI	Applicable Method
/_scripts/painless/_context	GET
/_scripts/painless/_execute	POST, GET
/{index}/_block/{block}	PUT

Compatible version 7.x APIs

Note

You can add a header prefix to use ES version 7.x APIs. For more information, see REST API compatibility.

Category	API URI	Applicable Method
Document APIs	/{index}/{type}/{id}/_update	POST
	/{index}/{type}/_bulk	PUT, POST
	/{index}/{type}/{id}	DELETE
	/{index}/{type}/_mget	POST, GET
	/{index}/{type}/{id}/_source	GET, HEAD
	/{index}/{type}/{id}	GET, HEAD
	/{index}/{type}	POST
	/{index}/{type}/{id}/_create	PUT, POST
	/{index}/{type}/{id}	PUT, POST
	/{index}/{type}/_update_by_query	POST
	/{index}/{type}/_delete_by_query	POST
	/{index}/{type}/_termvectors	POST, GET
	/{index}/{type}/{id}/_termvectors	POST, GET
	/{index}/{type}/_mtermvectors	POST, GET
Index APIs	/_mapping/{type}	GET
	/{index}/_mapping/{type}	GET, HEAD
	/{index}/_mappings/{type}	GET
	/{index}/{type}/_mapping	GET
	/_mapping/{type}/field/{fields}	GET
	/{index}/_mapping/{type}/field/{fields}	GET
	/{index}/{type}/_mapping/field/{fields}	GET
	/_mappings/{type}	PUT, POST
	/_mapping/{type}	PUT, POST
	/{index}/_mapping/{type}	PUT, POST
	/{index}/{type}/_mapping	PUT, POST
	/{index}/_mappings/{type}	PUT, POST
	/{index}/{type}/_mappings	PUT, POST
Search APIs	/{index}/{type}/{id}/_explain	POST, GET
	/{index}/{type}/_msearch	POST, GET
	/{index}/{type}/_search	POST, GET
	/{index}/{type}/_count	POST, GET
	/{index}/{type}/_search/template	POST, GET
	/{index}/{type}/_msearch/template	POST, GET
	/{index}/{type}/_validate/query	POST, GET
Security APIs	/_xpack/security/_authenticate	GET
	/_xpack/security/user/_has_privileges	POST, GET
	/_xpack/security/user/_privileges	GET
	/_xpack/security/privilege/	GET