Elasticsearch Serverless服務支持開源的API,本文介紹檢索通用型應用支持的開源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
功能,將會出現寫入后無法立即可見和查詢的情況。
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 |
支持的其他APIs
API URI | 適用Method |
GET | |
POST、GET | |
PUT、GET、DELETE | |
POST、GET | |
GET | |
POST | |
GET | |
POST | |
POST、GET |
可白名單開放的APIs
如果您需要使用下表中的API,可以提交工單或通過ES Serverless用戶群(釘釘群號:11205017670或72335013004)聯系客服添加白名單,請說明需要使用的API并描述使用場景。
API URI | Method |
POST | |
POST | |
POST | |
POST | |
POST |