Elasticsearch Serverless服务支持开源的API,本文介绍7.10版本应用支持的开源API URI和对应的Method。
注意事项
请谨慎使用本文列表之外的API接口。ES Serverless应用可能对部分未开放的API采用mock返回方式,返回结果非真实业务数据,例如
/_cluster/health
、/{index}/_ilm/explain
、/_xpack
等。大量refresh会造成集群写入速度变慢,响应时间变长,建议不要在写入时设置refresh,如需refresh,建议通过
_refresh
API主动调用。企业版应用在使用API查询应用索引时存在限制。如果写入设置refresh为true或wait_for,需要在查询时通过指定参数
preference=_primary
实现,否则refresh将不生效。如果您使用了spring data repository
功能,将会出现写入后无法立即可见和查询的情况。
检索场景的应用支持的API
Compact and aligned text (CAT) APIs
API URI | 适用Method |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET | |
GET |
Document APIs
API URI | 适用Method |
PUT、POST | |
POST、GET | |
POST、GET | |
PUT、POST | |
PUT、POST | |
POST | |
PUT、POST、GET、HEAD、DELETE | |
POST、GET | |
POST、GET | |
GET、HEAD | |
POST、GET | |
POST、GET | |
POST | |
POST | |
PUT、POST | |
POST、GET | |
POST、GET | |
POST、GET | |
PUT、POST、GET、HEAD、DELETE | |
PUT、POST | |
GET、HEAD | |
POST、GET | |
POST |
Index APIs
API URI | 适用Method |
PUT、GET | |
PUT、POST、GET、HEAD | |
POST、GET | |
PUT、POST | |
POST、GET | |
POST | |
GET | |
PUT、POST、GET、HEAD、DELETE | |
POST、GET | |
POST、GET | |
GET | |
POST | |
POST | |
POST | |
PUT、POST、GET、HEAD、DELETE | |
GET | |
PUT、POST、GET | |
GET | |
GET | |
GET | |
PUT、POST | |
POST | |
POST、GET | |
GET | |
PUT、GET | |
GET | |
GET | |
GET | |
GET | |
PUT、POST、GET、HEAD、DELETE | |
PUT、GET、HEAD、DELETE | |
POST | |
PUT、GET、HEAD | |
PUT、POST、GET、HEAD、DELETE | |
PUT | |
PUT、POST、DELETE | |
POST、GET | |
PUT | |
POST、GET | |
POST、GET | |
GET | |
PUT、POST | |
PUT、POST、GET、HEAD | |
GET | |
GET | |
GET | |
PUT、POST | |
PUT、POST、GET | |
POST | |
POST、GET | |
GET | |
GET | |
PUT、GET | |
GET | |
GET | |
GET | |
PUT、POST、GET | |
GET | |
PUT、POST |
Search APIs
API URI | 适用Method |
POST | |
GET、DELETE | |
POST、GET | |
POST、GET | |
POST、GET | |
GET | |
POST、GET | |
POST、GET | |
POST、GET、DELETE | |
POST、GET | |
POST | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET | |
POST、GET |
其他
API URI | 适用Method |
GET | |
POST、GET | |
PUT、GET、DELETE | |
POST、GET | |
GET | |
POST | |
GET | |
POST | |
POST、GET |
可白名单开放的API
如果您需要使用下表中的API,可以提交工单或通过ES Serverless用户群(钉钉群号:11205017670或72335013004)联系客服添加白名单,请说明需要使用的API并描述使用场景。
API URI | Method |
POST | |
POST | |
POST | |
POST | |
POST |