文档

API概览

更新时间:
本产品(Elasticsearch Serverless服务/2023-06-27)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

API目录

API标题API概述
CreateApp创建应用调用CreateApp接口,创建Elasticsearch Serverless应用。
UpdateApp更新应用调用UpdateApp接口,更新Elasticsearch Serverless应用相关信息,包括备注、网络开关、IP白名单组、账号密码等。
ListApps应用列表调用ListApps接口,查看Elasticsearch Serverless应用的列表。
GetApp获取应用详情调用GetApp接口,获取Elasticsearch Serverless应用的详情信息。
DeleteApp删除应用调用DeleteApp接口,删除Elasticsearch Serverless应用。
GetMonitorData获取应用监控数据调用GetMonitorData接口,获取Elasticsearch Serverless应用监控的指标数据。

应用配额和服务限制

API标题API概述
GetAppQuota查看应用配额调用GetAppQuota接口,获取Elasticsearch Serverless应用的配额信息。

终端节点

API标题API概述
CreateEndpoint创建终端节点调用CreateEndpoint接口,创建ES Serverless应用的私网终端节点。目前仅支持创建VPC类型的端点,用来打通用户VPC网络和ES Serverless服务的网络。调用该接口会默认帮助用户创建AliyunServiceRoleForESServerless角色。
  • 本页导读 (1)