API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (es-serverless/2023-06-27) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Applications
|
API |
Title |
Description |
| CreateApp | Create Application | To create an Elasticsearch Serverless application, call the CreateApp API. |
| UpdateApp | Update Application | Call the UpdateApp API to update Elasticsearch Serverless application information, such as remarks, network settings, IP address whitelist groups, and account passwords. |
| GetApp | Retrieve application details | Retrieves the details of an Elasticsearch Serverless application. |
| ListApps | List applications | Queries the list of Elasticsearch Serverless applications. |
| DeleteApp | Delete an application | Delete an Elasticsearch Serverless application. |
| GetAppQuota | View application quotas | Queries the quota information of an Elasticsearch Serverless application. |
| GetMonitorData | Retrieve application monitoring data | Retrieves the metric data for Elasticsearch Serverless application monitoring. |
| ListIndices | View Index List | Call the ListIndices operation to view the list of indexes for an ES Serverless application. |
Data backup
|
API |
Title |
Description |
| CreateSnapshot | Create a snapshot | Creates a snapshot for an Elasticsearch Serverless application. |
| UpdateSnapshotSetting | Modify Automatic Backup Configuration | The UpdateSnapshotSetting API modifies the automatic backup snapshot configuration for an Elasticsearch Serverless application. |
| ListSnapshots | Obtain Snapshot List | Call the ListSnapshots operation to retrieve a list of snapshots for an ES Serverless application. |
| ListSnapshotRepositories | List snapshot backup repositories | Retrieves the list of snapshot backup repositories for an Elasticsearch Serverless application. |
| GetSnapshotSetting | Retrieve automatic backup configuration | Retrieves the automatic backup configuration of an Elasticsearch Serverless application. |
| DeleteSnapshot | Delete a snapshot | Deletes a snapshot of an Elasticsearch Serverless application. |
Dictionaries
|
API |
Title |
Description |
| UpdateDict | Create or Modify Dictionary | Call the UpdateDict operation to create or update a dictionary for an Elasticsearch Serverless application. You can upload dictionaries only from OSS. |
| ListDicts | Retrieve dictionary list | Retrieves the list of dictionaries for an Elasticsearch Serverless application. |
| DeleteDict | Delete a dictionary | Deletes a dictionary for an Elasticsearch Serverless application. |
Endpoints
|
API |
Title |
Description |
| CreateEndpoint | Create an endpoint | Creates a private network endpoint for an Elasticsearch Serverless application. You can create up to 50 endpoints in each area. Currently, you can only create a VPC endpoint to connect your VPC network to the Elasticsearch Serverless network. When you invoke this operation, it creates the AliyunServiceRoleForESServerless role by default. |
| UpdateEndpoint | Modify endpoint information | Call the UpdateEndpoint operation to modify an endpoint in the ES Serverless platform. |
| ListEndpoints | List endpoints | Queries a list of VPC endpoints created on the Elasticsearch Serverless platform. |
| DeleteEndpoint | Delete an endpoint | Deletes an endpoint created on the Elasticsearch Serverless platform. |
Specification approval tasks
|
API |
Title |
Description |
| ListSpecReviewTasks | View the List of Specification Approval Tickets | Call ListSpecReviewTasks to retrieve the list of approval tickets for specification changes in an ES Serverless application. |
| GetSpecReviewTask | View specification review ticket details | Queries the details of a specification review ticket for an Elasticsearch Serverless application. |
| CancelSpecReviewTask | Cancel approval ticket | Cancels an approval ticket for ES Serverless application specifications. |
Others
|
API |
Title |
Description |
| UpdatePrivateNetwrok | Update application internal-facing configuration | Updates the private network information of an application. |
| UpdateNetwork | Update application Internet configuration | Updates the public network configuration for an application. |