本产品（es-serverless/2023-06-27）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
应用
|
API |
标题 |
API概述 |
| CreateApp | 创建应用 | 调用CreateApp接口，创建Elasticsearch Serverless应用。 |
| UpdateApp | 更新应用 | 调用UpdateApp接口，更新Elasticsearch Serverless应用相关信息，包括备注、网络开关、IP白名单组、账号密码等。 |
| GetApp | 获取应用详情 | 调用GetApp接口，获取Elasticsearch Serverless应用的详情信息。 |
| ListApps | 应用列表 | 调用ListApps接口，查看Elasticsearch Serverless应用的列表。 |
| DeleteApp | 删除应用 | 调用DeleteApp接口，删除Elasticsearch Serverless应用。 |
| GetAppQuota | 查看应用配额 | 调用GetAppQuota接口，获取Elasticsearch Serverless应用的配额信息。 |
| GetMonitorData | 获取应用监控数据 | 调用GetMonitorData接口，获取Elasticsearch Serverless应用监控的指标数据。 |
| ListIndices | 查看索引列表 | 调用ListIndices接口，查看ES Serverless应用的索引列表。 |
数据备份
|
API |
标题 |
API概述 |
| CreateSnapshot | 创建快照 | 调用CreateSnapshot，创建ES Serverless应用的快照。 |
| UpdateSnapshotSetting | 修改自动备份配置 | 调用UpdateSnapshotSetting接口，修改ES Serverless应用自动备份快照的配置。 |
| ListSnapshots | 获取快照列表 | 调用ListSnapshots接口，获取ES Serverless应用的快照列表。 |
| ListSnapshotRepositories | 获取快照备份仓库列表 | 调用ListSnapshotRepositories接口，获取ES Serverless应用快照的备份仓库列表。 |
| GetSnapshotSetting | 获取自动备份配置 | 调用GetSnapshotSetting接口，获取ES Serverless应用的自动备份配置。 |
| DeleteSnapshot | 删除快照 | 调用DeleteSnapshot接口，删除ES Serverless应用快照。 |
词典
|
API |
标题 |
API概述 |
| UpdateDict | 创建或修改词典 | 调用UpdateDict接口，创建或修改ES Serverless应用词典。目前仅支持通过OSS地址上传。 |
| ListDicts | 获取词典列表 | 调用ListDicts接口，获取ES Serverless应用的词典列表。 |
| DeleteDict | 删除词典 | 调用DeleteDict接口，删除ES Serverless应用的词典。 |
终端节点
|
API |
标题 |
API概述 |
| CreateEndpoint | 创建终端节点 | 调用CreateEndpoint接口，创建ES Serverless应用的私网终端节点。目前仅支持创建VPC类型的端点，用来打通用户VPC网络和ES Serverless服务的网络。调用该接口会默认帮助用户创建AliyunServiceRoleForESServerless角色。 |
| UpdateEndpoint | 修改终端节点信息 | 调用UpdateEndpoint接口，修改ES Serverless平台中创建的终端节点。 |
| ListEndpoints | 获取终端节点列表 | 调用ListEndpoints接口，获取在ES Serverless平台创建的VPC终端节点列表。 |
| DeleteEndpoint | 删除终端节点 | 调用DeleteEndpoint接口，删除在ES Serverless平台创建的终端节点。 |
规格审批任务
|
API |
标题 |
API概述 |
| ListSpecReviewTasks | 查看规格审批工单列表 | 调用ListSpecReviewTasks，查看ES Serverless应用中申请修改规格的审批工单列表。 |
| GetSpecReviewTask | 查看规格审批工单详情 | 调用GetSpecReviewTask接口，查看ES Serverless应用的规格审批工单详情。 |
| CancelSpecReviewTask | 撤销审批工单 | 调用CancelSpecReviewTask接口，撤销ES Serverless应用规格审批工单。 |
其 他
|
API |
标题 |
API概述 |
| UpdatePrivateNetwrok | 更新应用私网配置 | 修改应用私网信息。 |
| UpdateNetwork | 更新应用公网配置 | 修改应用公网配置。 |
该文章对您有帮助吗？