# Alibaba Cloud Elasticsearch API

> Alibaba Cloud Elasticsearch API on Apizie: 207 endpoints (Restores offline zones. This operation is valid only for multi-zone instances, Configures network connectivity between different instances, Creates a reference repository when configuring a cross-cluster OSS repository, Restores an Elasticsearch instance that was frozen after release, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-elasticsearch`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/elasticsearch
- Page: https://zieapi.vercel.app/api/cloud/aliyun-elasticsearch
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-elasticsearch/openapi.json

Alibaba Cloud OpenAPI for Elasticsearch (elasticsearch, version 2017-06-13). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Restores offline zones. This operation is valid only for multi-zone instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/activate-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Specifies the client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you… |
| body | string | no | The request body |

### Configures network connectivity between different instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/add-connectable-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The current instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |
| body | string | no | The remote instance ID. Specifies the remote instance ID for which you want to configure network connectivity. The remote instance must… |

### Creates a reference repository when configuring a cross-cluster OSS repository
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/add-snapshot-repo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The destination instance ID. This is the instance ID for which you need to configure the cross-cluster OSS repository Settings |
| body | string | no | Specifies the cross-cluster backup information, namely the reference instance |

### Restores an Elasticsearch instance that was frozen after release
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/cancel-deletion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |

### Resumes a Logstash instance that was frozen after release
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/cancel-logstash-deletion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |

### Cancels a running data migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/cancel-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| taskType | string | yes | The task type. Set the value to MigrateData, which specifies a data migration task |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |

### Recommends the optimal cluster capacity planning configuration based on business scenarios, QPS, and log…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/capacity-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| complexQueryAvailable | string | no | Specifies whether complex aggregation query is required. Valid values: true: Required. false (default): Not required |
| dataInfo | array | no | The disk usage information |
| metric | array | no | The metric information for disk usage, search and write operations, and aggregation requests |
| usageScenario | string | no | Scenarios. Valid values: general: general-purpose scenario analysisVisualization: data analytics scenario dbAcceleration: database… |

### Disables the intelligent O&M feature for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/close-diagnosis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |
| lang | string | no | Specifies the language. By default, the browser language is used. Valid values: en: English zh: Simplified Chinese zt: Traditional Chinese… |

### Disables the HTTPS protocol for the cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/close-https` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique across… |

### Disables the cloud hosting feature for an index in an Indexing Service cluster. This operation is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/close-managed-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across requests. The value can be up to 64… |
| Index | string | yes | The name of the index. For more information, see https://help.aliyun.com/document_detail/213188.html |

### Creates a collector to collect data from a specified service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-collector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| clientToken | string | no | The client token used to ensure the idempotence of the request. The value is generated by the client and must be unique across different… |
| collectorPaths | array | no | The collection path for Filebeat. This parameter is required only when the collector is installed on an ECS instance |
| configs | array | yes | The configuration file information of the collector |
| dryRun | string | yes | Specifies whether to validate and create the collector. This parameter is used only when you create or update a collector. Valid values:… |
| extendConfigs | array | yes | The extended configuration of the collector |
| name | string | yes | The name of the collector. The name must be 1 to 30 characters in length and must start with a letter. It can contain letters, digits,… |
| resType | string | yes | The type of the collector. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat |
| resVersion | string | yes | The version of the collector. Valid values: 6.8.5_with_community: deployed on ECS instances. 6.8.13_with_community: deployed on ACK clusters |
| vpcId | string | yes | The ID of the virtual private cloud (VPC) where the collector resides |

### Creates an Elasticsearch composable template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-component-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | yes | The name of the template |
| _meta | object | no | The metadata used to store information such as remarks |
| template | object | no | The composable template information |

### Creates a data stream to manage a set of indexes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-data-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |
| body | string | no | The name of the data stream to create, represented as a JSON string |

### Creates an index lifecycle policy. If the specified policy name already exists, the existing policy is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-ilmpolicy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| body | string | no | The name and phase configurations of the index lifecycle policy to be created |

### Creates a cluster index template that can be used for component-based index template settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-index-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different… |
| dataStream | string | yes | Specifies whether to enable data streams. Valid values: true: Enabled. false (default): Disabled |
| ilmPolicy | string | no | The lifecycle policy name |
| indexPatterns | array | yes | The index matching pattern (regular expression) |
| indexTemplate | string | yes | The index template name |
| priority | integer | no | The priority of the cluster index template |
| template | object | no | The template settings. For more information, see Multiple Component Templates… |

### Creates a Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-logstash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| clientToken | string | no | A unique token generated by the client to guarantee the idempotency of the request. The maximum length is 64 ASCII characters |
| description | string | no | The instance name |
| networkConfig | object | yes | The network configuration |
| nodeAmount | integer | yes | The number of nodes in the instance |
| nodeSpec | object | yes | The configuration of data nodes |
| paymentInfo | object | no | The billing details of the subscription instance. This parameter is required when you create a subscription instance |
| paymentType | string | no | The billing method of the instance. Valid values: prepaid: subscription postpaid: pay-as-you-go |
| resourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| version | string | yes | The instance version. Valid values: 6.7_with_X-Pack 7.4_with_X-Pack |

### Creates a Logstash pipeline to collect data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| trigger | string | no | Specifies whether to save and deploy the pipeline. Valid values: true: Save and deploy. false (default): Save only |
| ClientToken | string | no | A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different… |
| body | array | no | The request body parameters that specify pipeline information. For more information, see logstash.yml… |

### Creates a manual snapshot backup for a cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-snapshot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ClientToken | string | yes | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique across… |
| InstanceId | string | yes | The instance ID |
| body | string | no | No request body is required. This operation creates a snapshot by using the instance ID in the path |

### Creates a PrivateLink VPC endpoint to connect to an endpoint service created in a user VPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/create-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among… |
| dryRun | string | no | Specifies whether to perform a dry run. Valid values: true: sends a check request without creating an endpoint. The system checks whether… |
| serviceId | string | no | The ID of the endpoint service that you created. The service VPC endpoint will be associated with this service ID |
| zoneId | string | no | The zone ID of the endpoint service that you created |

### Takes some zones offline when multiple zones are available, and migrates the nodes in the offlined zones to…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/deactivate-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| body | string | no | The IDs of the zones to be taken offline |

### Deletes a specified collector
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-collector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ResId | string | yes | The collector ID |
| ClientToken | string | no | A unique token used to ensure idempotence. Generated by the client. The value must be unique across different requests and cannot exceed… |

### Deletes a composite index template for Elasticsearch
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-component-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | yes | The name of the composite template |

### Deletes the network connectivity between two instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-connected-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The current instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |
| connectedInstanceId | string | yes | The instance ID of the remote instance that is connected over the network |

### Deletes a specified cluster data stream
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-data-stream` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | A unique token used to ensure the idempotence of the request. This parameter value is generated by the client and must be unique across… |
| DataStream | string | yes | The name of the data stream |

### Deletes an Elasticsearch index migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-data-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ClientToken | string | yes | A client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| InstanceId | string | yes | The instance ID |
| taskId | string | yes | The index migration task ID |

### Deletes a historical index template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-deprecated-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | yes | The index template name |

### Deletes a specified index lifecycle policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-ilmpolicy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PolicyName | string | yes | The index life epoch policy Policy Name |

### Deletes a specified index template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-index-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| IndexTemplate | string | yes | The name of the index template |

### All physical resources used by the instance are reclaimed, all related data is permanently lost and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make… |
| deleteType | string | no | The release type. Valid values: immediate: The instance is immediately deleted. After deletion, the system permanently clears all data,… |

### Proactively releases a Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-logstash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | A unique token that is used to ensure idempotency. This token is generated by the client and must be unique across different requests. The… |
| deleteType | string | no | The release type. Valid values: immediate: immediately deletes the instance. After deletion, the system permanently clears all data, and… |

### Deletes pipelines configured for a Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-pipelines` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| ClientToken | string | no | A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and cannot… |
| pipelineIds | string | no | The pipeline ID |

### Deletes a cross-cluster OSS reference repository from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-snapshot-repo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| repoPath | string | yes | The referenced instance ID. To obtain this parameter, refer to https://help.aliyun.com/document_detail/178513.html |
| clientToken | string | no | A unique token used to ensure idempotence of the request. Generated by the client, this value must be unique across different requests and… |

### Calls DeleteVpcEndpoint to delete an endpoint in the service VPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/delete-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| EndpointId | string | yes | The ID of the endpoint to delete |

### Calls the DescribeAckOperator operation to query the Elasticsearch Operator information installed on a…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-ack-operator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The ID of the target cluster |

### Queries the details of a collector instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-collector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ResId | string | yes | The instance ID of the collector |

### Queries the details of a composable index template in Elasticsearch
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-component-index` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | yes | The name of the composable template |

### Retrieves the list of instances that can establish private network peering with the current instance.…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-connectable-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The current instance ID |
| alreadySetItems | string | no | Specifies whether to return instances that are already connected. Valid values: true (default): The returned instance list includes… |

### Queries the details of a historical index template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-deprecated-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | yes | The index template name |

### Queries the historical reports of intelligent O&M
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-diagnose-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | The language used to generate the intelligent diagnostic report. Default value: the browser language. Valid values: en: English zh:… |
| ReportId | string | yes | The report ID. You can call the https://help.aliyun.com/document_detail/183774.html operation to obtain the report ID |

### Queries the scenario settings for intelligent O&M
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-diagnosis-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | Specifies the language of the response. Default value: en |

### Retrieves the dynamic metrics of a cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-dynamic-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Elasticsearch instance ID |

### Queries the health status of a cluster to check whether it is running normally
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-elasticsearch-health` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The request ID |

### Queries the details of a specified index lifecycle policy
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-ilmpolicy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PolicyName | string | yes | The name of the index lifecycle policy |

### Retrieves information about an index template
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-index-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| IndexTemplate | string | yes | The name of the index template |

### Queries the details of a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the Kibana node configuration of an Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-kibana-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the details of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-logstash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the pipeline information of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| PipelineId | string | yes | The pipeline ID |

### Retrieves the pipeline management configuration of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-pipeline-management-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| clientToken | string | no | A unique token generated by the client to ensure idempotence of the request. The token can contain up to 64 ASCII characters and must be… |

### Retrieves the region information of Alibaba Cloud Elasticsearch
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |

### Retrieves the snapshot backup settings and backup cycle of a cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-snapshot-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the scenario-specific template configuration and cluster settings configuration of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the X-Pack monitoring configuration of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/describe-xpack-monitor-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |

### Diagnoses an instance immediately
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/diagnose-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | The language of the report to obtain. Default value: the browser language. Valid values: en: English zh: Simplified Chinese zt:… |
| ClientToken | string | no | Ensures the idempotence of the request. The parameter value is generated by the client and must be unique across different requests. The… |
| diagnoseItems | array | no | The diagnostic items |
| indices | array | no | The list of indexes to be diagnosed |
| type | string | no | The type of the diagnostic task. Valid values: ALL: Diagnoses all indexes. SELECT: Diagnoses selected indexes |

### Disables Kibana private network access
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/disable-kibana-pvl-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Invokes the EnableKibanaPvlNetwork operation to enable private network access for Kibana
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/enable-kibana-pvl-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request |
| endpointName | string | no | The endpoint name |
| managedSecurityGroup | string | no | The managedSecurityGroup |
| securityGroups | array | no | The security groups |
| vSwitchIdsZone | array | no | The vSwitch and zone information |
| vpcId | string | no | The VPC-connected instance ID |

### Retrieves the estimated restart time for a Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/estimated-logstash-restart-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| force | string | no | Specifies whether to forcibly restart the instance. Default value: false |
| body | string | no | The restart parameters, including the restart type, target nodes, blue-green deployment options, and concurrency settings |

### Retrieves the estimated restart time of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/estimated-restart-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| force | string | no | Specifies whether to force a restart. Default value: false |
| body | string | no | The restart parameters, such as the restart method, target nodes, and blue-green deployment, represented as a JSON string |

### Retrieves the index migration data information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-cluster-data-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| body | string | no | The cluster type, access endpoint, and index to be queried |

### Retrieves the elastic scaling rules for a cluster. Elastic nodes must be purchased when the instance is…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-elastictask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the list of Grafana alerts
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-emon-grafana-alerts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the monitoring and alerting project. The format is es- |
| body | string | no | This GET operation does not require a request body |

### Retrieves the list of Grafana dashboards
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-emon-grafana-dashboards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The ID of the monitoring and alerting project. The format is es- |
| body | string | no | This GET operation does not require a request body |

### Queries the Grafana metric monitoring data of an Elasticsearch instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-emon-monitor-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ProjectId | string | yes | The project ID. The format is `es-current account ID` |
| body | string | no | The Grafana metric monitoring query conditions, including the query start time, metric expression, and metric query list |

### Queries the keystore configurations of a specified Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-keystores` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the storage capacity and usage of an OpenStore instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-open-store-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Retrieves the current region information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-region-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| zoneId | string | no | The current zone ID |

### Retrieves the nodes that can be removed based on the specified node type and quantity
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-suggest-shrinkable-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| nodeType | string | yes | The type of nodes to scale in. WORKER indicates hot nodes. WORKER_WARM indicates warm nodes |
| count | integer | yes | The expected number of nodes available for scale-in to retrieve |
| ignoreStatus | string | no | Specifies whether to ignore the instance status. Default value: false |

### Retrieves the nodes that are available for data migration based on the specified node type and count
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/get-transferable-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| nodeType | string | yes | The type of nodes for data migration. WORKER indicates hot nodes. WORKER_WARM indicates warm nodes |
| count | integer | yes | The expected number of nodes to retrieve for data migration |

### Continues the canary release by restarting the remaining nodes of an Elasticsearch instance after the canary…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/gray-publish` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the Elasticsearch instance. This parameter is required |
| X-Request-ChangeId | string | no | The change ID |

### Initializes AI models
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/init-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| api_key | string | yes | The API key for the AI Search Open Platform |
| host | string | yes | The service registration address for the AI Search Open Platform |
| http_schema | string | yes | The HTTP protocol type |
| models | array | no | Specifies the models to initialize. If this parameter is left empty, all built-in models are initialized |
| workspace | string | yes | The workspace |

### Creates a service-linked role
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/initialize-operation-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates the value. The value must be unique among… |
| body | string | no | The name of the Elasticsearch service-linked role to be created |

### Installs the ACK Operator on a specified container service cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/install-ack-operator` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The ID of the destination cluster |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique across… |
| body | string | no | This operation installs the ACK Operator by using the cluster ID in the path. No request body is required |

### Installs preset Kibana plugins. The Kibana specifications must be at least 2 vCPUs and 4 GiB of memory
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/install-kibana-system-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |
| body | string | no | The names of the preset Kibana plugins to install, represented as a JSON array string |

### Installs system plugins for a specified Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/install-logstash-system-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The parameter value is generated by the client and must be unique across different requests. The… |
| body | string | no | The list of names of the Logstash plugins to be installed |

### Installs system plugins for an Elasticsearch instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/install-system-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |
| body | string | no | The list of names of Elasticsearch preset plugins to install, represented as a JSON array string |

### Installs custom user plugins that have been uploaded to the Elasticsearch console
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/install-user-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| force | string | no | Specifies whether to forcibly install custom user plugins. Default value: false. Instances with the legacy architecture do not support… |
| body | string | no | The list of custom plugins |

### Interrupts an instance change task. This operation is valid only for instances in the active state. After…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/interrupt-elasticsearch-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Suspends an instance modification task. After the task is suspended, the instance enters the suspended state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/interrupt-logstash-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| clientToken | string | no | Ensures the idempotence of the request. The value is generated by the client and must be unique across different requests. The value can… |

### Invokes the Alibaba Cloud Elasticsearch Agent service based on the JSON-RPC 2.0 protocol. It supports…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/invoke-es-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| body | object | no | The request body in JSON-RPC 2.0 format. Unified request parameters (all located at the top level of the request body, not inside params):… |

### Uses a registered managed credential to proxy access to the native ES API. The accessible scope is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/invoke-es-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| path | string | yes | The ES path to access. This parameter is required. The leading / can be omitted |
| method | string | no | The HTTP method used to access ES. Default value: GET |
| credentialId | string | no | The ID of the credential to use. If this parameter is not specified, the default credential of the instance is used |
| body | string | no | The request body passed through to ES. Set this parameter based on the requirements of the target ES API. This parameter is not required… |
| system | string | no | Specifies whether to use the Alibaba Cloud ES system credential. Default value: false |

### Retrieves the list of Container Service for Kubernetes (ACK) clusters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-ack-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | [Deprecated] The page number |
| size | integer | no | [Deprecated] The number of entries per page |
| vpcId | string | no | The ID of the VPC where the ACK cluster is deployed |

### Queries all namespaces of a specified Container Service for Kubernetes (ACK) cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-ack-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number. (Deprecated) |
| size | integer | no | The number of records per page. (Deprecated) |
| ClusterId | string | yes | The ID of the target cluster |

### Queries change records and change details
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-action-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | A short description of struct |
| requestId | string | no | Filters records by the ID of the request that triggered the change |
| userId | string | no | Filters records by the ID of the user that triggered the change |
| actionNames | string | no | Filters records by the name of the change operation. Separate multiple names with commas |
| filter | string | no | The display type of change records. Default value: ACTION_RECORD |
| page | integer | no | The page number of the returned results |
| size | integer | no | The number of records returned per page |
| startTime | integer | no | The lower bound of the query range for the change start time. The value is a UNIX timestamp in milliseconds |
| endTime | integer | no | The upper bound of the query range for the change start time. The value is a UNIX timestamp in milliseconds. If you do not specify this… |

### Retrieves information about all nodes in an Elasticsearch cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-all-node` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| extended | string | no | Specifies whether to return monitoring information for nodes. Valid values: true (default): Returns monitoring information. false: Does… |

### Retrieves the OSS reference repositories that can be added to the current instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-alternative-snapshot-repos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| alreadySetItems | string | no | Specifies whether to return the added OSS reference repositories. Default value: true. Valid values: true: Returns the added OSS reference… |

### Retrieves the list of available Elasticsearch instances when configuring X-Pack monitoring for a Logstash…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-available-es-instance-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |

### Retrieves the list of collectors
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-collectors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| resId | string | no | The collector ID |
| name | string | no | The collector name |
| instanceId | string | no | The instance ID associated with the collector |
| page | integer | no | The page number of the returned results. Default value: 1. Minimum value: 1. Maximum value: 200 |
| size | integer | no | The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 500 |
| sourceType | string | no | Specifies the type of machine on which the collector is deployed. If you do not specify this parameter, all types are returned. Valid… |

### Retrieves the list of composable templates in Elasticsearch
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-component-indices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | no | The name of the composable template |
| page | integer | no | The paging Settings for the page number in a paged query. Default value: 1 |
| size | integer | no | The paging Settings for the number of entries per page in a paged query. Default value: 10 |

### Retrieves a list of instances that have established network connectivity with the current instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-connected-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The current instance ID |

### Retrieves the list of index data streams in an Elasticsearch cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-data-streams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| isManaged | string | no | Specifies whether to display only managed indexes. Valid values: true: Only managed indexes are displayed. false (default): All indexes… |
| name | string | no | The data stream name |

### Retrieves a list of data migration tasks between different Elasticsearch clusters
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-data-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Invokes ListDefaultCollectorConfigurations to retrieve the default configuration file of a collector
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-default-collector-configurations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| resType | string | yes | The collector type. Valid values: fileBeat metricBeat heartBeat auditBeat |
| resVersion | string | yes | The collector version. The available versions vary depending on the machine type on which the collector is deployed. Valid values: ECS:… |
| sourceType | string | no | The type of machine on which the collector is deployed. If you do not specify this parameter, all types are returned. Valid values: ECS:… |

### Queries the list of historical index templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-deprecated-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | no | The index template name |
| page | integer | no | The page number settings for a paged query. This parameter is used for paging |
| size | integer | no | The number of entries per page settings for a paged query. This parameter is used for paging |

### Retrieves the diagnostic indexes from the intelligent O&M module for a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-diagnose-indices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | The language configuration. Default value: browser language. Valid values: en: English zh: Simplified Chinese zt: Traditional Chinese es:… |

### Retrieves historical reports of intelligent O&M
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-diagnose-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | The language of the reports to retrieve. Default value: the browser language. Valid values: en: English zh: Simplified Chinese zt:… |
| startTime | integer | yes | The start timestamp for the query. Unit: milliseconds. Minimum value: 1000000000000 Maximum value: 2000000000000 |
| endTime | integer | yes | The end timestamp for the query. Unit: milliseconds. Minimum value: 1000000000000 Maximum value: 2000000000000 |
| page | integer | no | The page number. Default value: 1. Minimum value: 1. Maximum value: 200 |
| size | integer | no | The number of reports per page. Default value: 10. Minimum value: 1. Maximum value: 500 |
| detail | string | no | Specifies whether to display the details of diagnostic items |
| trigger | string | no | The trigger method for health diagnostics. Valid values: SYSTEM (default): automatically triggered by the system INNER: internally… |

### Retrieves all IDs of intelligent O&M historical reports
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-diagnose-report-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| lang | string | no | The language of the reports to retrieve. Default value: the browser language. Valid values: en: English zh: Simplified Chinese zt:… |
| startTime | integer | yes | The start timestamp of the query. Minimum value: 1000000000000 ms Maximum value: 2000000000000 ms |
| endTime | integer | yes | The end timestamp of the query. Minimum value: 1000000000000 ms Maximum value: 2000000000000 ms |
| page | integer | no | The page number. Default value: 1. Minimum value: 1. Maximum value: 200 |
| size | integer | no | The number of report IDs per page. Default value: 10. Minimum value: 1. Maximum value: 500 |
| trigger | string | no | The trigger method of the health diagnostics. Valid values: SYSTEM (automatically triggered by the system), INNER (internally triggered),… |

### Lists the intelligent diagnostic items for an Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-diagnosis-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| lang | string | no | The supported request language. Default value: the browser request language. Valid values: en: English zh: Simplified Chinese zt:… |
| instanceId | string | no | The instance ID |
| level | string | no | The diagnostic item level. Valid values: BASIC: basic inspection item (free). ADVANCED: advanced inspection item (consumes billable… |

### Queries the information of a specified dictionary
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-dict-information` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| bucketName | string | yes | The name of the OSS bucket where the dictionary file is stored |
| key | string | yes | The storage path of the dictionary file in the OSS bucket |
| analyzerType | string | no | The type of the OSS dictionary to be added. Valid values: IK_HOT, IK, SYNONYMS, and ALIWS. Default value: IK |

### Queries the details of the dictionary list for a specified type
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-dicts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| analyzerType | string | yes | The dictionary type. Valid values: IK: IK cold update dictionary. IK_HOT: IK hot update dictionary. SYNONYMS: Synonym dictionary. ALIWS:… |
| name | string | no | The file name used to filter results |
| InstanceId | string | yes | The instance ID |

### Queries a list of ECS instances in the VPC and vSwitch of the current user
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-ecs-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number of the returned results. Maximum value: 500 |
| size | integer | no | The number of results per page. Default value: 10. Maximum value: 500 |
| ecsInstanceIds | string | no | The list of ECS instance IDs. The value can be a JSON array that consists of multiple instance IDs. You can specify up to 100 IDs.… |
| ecsInstanceName | string | no | The name of the ECS instance |
| tags | string | no | Instance tags of the ECS instance. A tag must contain the following fields: tagKey: instance tag key tagValue: instance tag value |
| vpcId | string | no | The ID of the VPC where the ECS instance resides |

### Retrieves a list of events
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-event-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| eventType | string | yes | The event type |
| termType | string | no | The object type to filter. If this parameter is empty, event records of all types are returned |
| termContent | string | no | The content of the object to filter. If this parameter is empty, event records for all instances are returned. Note: Specify the… |
| beginTime | string | no | The start time for the event query. Specify a UNIX timestamp in milliseconds |
| endTime | string | no | The end time for the event query. Specify a UNIX timestamp in milliseconds |
| page | integer | no | The page number in the paging Settings |
| size | integer | no | The number of entries per page in the paging Settings |

### Retrieves the extension file configuration of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-extendfiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |

### Queries the list of index lifecycle policies that have been created for a cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-ilmpolicies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| policyName | string | no | The name of the index lifecycle policy |

### Queries the list of index templates
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-index-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| indexTemplate | string | no | The index template name |
| page | integer | no | The page number of the instance list. Minimum value: 1. Default value: 1 |
| size | integer | no | The number of entries per page for a paged query. Maximum value: 100. Default value: 20 |

### Queries a list of Elasticsearch instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number of the instance list. Minimum value: 1. Default value: 1 |
| size | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 10 |
| description | string | no | The instance name. Fuzzy search is supported. For example, if you search for abc, instances such as abc, abcde, xyabc, and xabcy may be… |
| instanceId | string | no | The instance ID |
| esVersion | string | no | The Elasticsearch version of the instance |
| resourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| tags | string | no | The instance tags |
| vpcId | string | no | The ID of the virtual private cloud (VPC) to which the instance belongs |
| zoneId | string | no | The ID of the zone to which the instance belongs |
| paymentType | string | no | The billing method of the instance. Valid values: postpaid: pay-as-you-go prepaid: subscription |
| instanceCategory | string | no | The edition of the instance. Valid values: x-pack: Commercial Edition advanced/IS: Advanced Edition community: Basic Edition |
| status | string | no | The instance status used for filtering. Valid values: active, activating, inactive, invalid, and unknown |

### Queries the list of hardware O&M events triggered for an Elasticsearch cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-instance-history-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The instance ID |
| nodeIP | string | no | The IP address of the node that triggered the event |
| eventType | string | no | The event type (JSON-encoded) |
| eventLevel | string | no | The event level (JSON-encoded) |
| eventCreateStartTime | string | no | The start time for querying events by creation time. The value is a timestamp in milliseconds |
| eventCreateEndTime | string | no | The end time for querying events by creation time. The value is a timestamp in milliseconds |
| eventExecuteStartTime | string | no | The start time for querying events by execution time. The value is a timestamp in milliseconds |
| eventExecuteEndTime | string | no | The end time for querying events by execution time. The value is a timestamp in milliseconds |
| eventFinashStartTime | string | no | The start time for querying events by completion time. The value is a timestamp in milliseconds |
| eventFinashEndTime | string | no | The end time for querying events by completion time. The value is a timestamp in milliseconds |
| page | integer | no | The starting document offset. The value must be a non-negative number. Default value: 0 |
| size | integer | no | The number of events to return. The value must be a non-negative number. Default value: 10 |
| eventCycleStatus | string | no | The lifecycle status object of the event (JSON-encoded) |
| body | array | no | The request body parameters |

### Queries the list of indices in a cluster
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-instance-indices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| all | string | no | Specifies whether to retrieve all indices. Valid values: true: returns a list of indices including system indices. false: returns a list… |
| name | string | no | The index name. Fuzzy match is supported |
| isManaged | string | no | Specifies whether to view only managed indices. Valid values: true: views only managed indices. false: views all indices. Default value:… |
| isOpenstore | string | no | Specifies whether to view only OpenStore cold-phase indices. Valid values: true: views only OpenStore cold-phase indices. false: views all… |
| page | integer | no | The page number. Minimum value: 1. Default value: 1 |
| size | integer | no | The paging Settings for the number of entries per page in a paged query. Maximum value: 100. Default value: 20 |

### Retrieves the list of plugins installed on the Kibana node of an Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-kibana-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| page | string | no | The page number of the instance list. Default value: 1 |
| size | integer | no | The number of entries per page Settings for paging in a paged query |

### Invokes ListKibanaPvlNetwork to query the details of Kibana private network access
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-kibana-pvl-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Queries the details of all or specified Logstash instances
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-logstash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number of the instance list. Default value: 1 |
| size | integer | no | The number of entries per page in a paging query. Default value: 20 |
| description | string | no | The name of the instance. Fuzzy match is supported. For example, if you search for instances named abc, the system may return all… |
| instanceId | string | no | The instance ID |
| version | string | no | The version of the instance |
| resourceGroupId | string | no | The ID of the resource group |
| tags | string | no | The instance tags |

### Queries the logs of a Logstash instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-logstash-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| type | string | yes | The log type. Valid values: LOGSTASH_INSTANCE_LOG: main log. SEARCHSLOW: searching slow log. INDEXINGSLOW: indexing slow log. JVMLOG: GC… |
| query | string | yes | The keyword to query |
| beginTime | integer | no | The beginning of the time range to query logs. This value is a UNIX timestamp. Unit: milliseconds |
| endTime | integer | no | The end of the time range to query logs. This value is a UNIX timestamp. Unit: milliseconds |
| page | integer | no | The page number of the instance list. Default value: 1. Minimum value: 1. Maximum value: 200 |
| size | integer | no | The number of entries per page for the paged query. Default value: 20. Minimum value: 1. Maximum value: 100 |

### Calls ListLogstashPlugins to retrieve detailed information about all or specified plugins
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-logstash-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | no | The plugin name |
| page | integer | no | The page number of the plugin list. Default value: 1. Minimum value: 1. Maximum value: 200 |
| size | integer | no | The number of entries per page for paging. Minimum value: 1. Maximum value: 200 |
| source | string | no | The plugin source. Valid values: USER: custom plugin SYSTEM: system preset plugin |

### Queries the machine status under a search collector
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| page | integer | no | The page number of the returned results |
| size | integer | no | The number of results per page |
| ecsInstanceIds | string | no | The list of ECS instance IDs |
| ecsInstanceName | string | no | The ECS instance name |
| tags | string | no | The tag information of the ECS instance. Must include the tag key (tagKey) and tag value (tagValue) |
| ResId | string | yes | The collector ID |

### Retrieves the list of Logstash pipelines
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| pipelineId | string | no | The ID of the pipeline |
| page | integer | no | Specifies the page number for a paged query. Valid values: 1 to 200. Default value: 1 |
| size | integer | no | Specifies the number of pipelines per page for a paged query. Valid values: 1 to 200 |

### Retrieves a list of pipeline IDs for a Logstash instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-pipeline-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The Logstash instance ID |
| body | string | no | The request body parameters. For more information, see the RequestBody section below |

### Retrieves the plugin list of a specified Alibaba Cloud Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| name | string | no | The plugin name |
| page | string | no | The page number |
| size | integer | no | The number of records per page |
| source | string | no | The plugin source type. Only SYSTEM (system plugin) is supported |

### Queries logs of different types for an Elasticsearch instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-search-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| type | string | yes | The log type. Valid values: INSTANCELOG: primary log. SEARCHSLOW: searching slow log. INDEXINGSLOW: indexing slow log. JVMLOG: GC log.… |
| query | string | yes | The keyword to query |
| beginTime | integer | no | The start timestamp of the log, in milliseconds. The value must be within the last 7 days. If this parameter is not specified, all logs… |
| endTime | integer | no | The end timestamp of the log, in milliseconds. The value must be within the last 7 days. Specify this parameter. If this parameter is not… |
| page | integer | no | The page number of the plugin list. Minimum value: 1. Default value: 1 |
| size | integer | no | The number of entries per page for a paged query. Default value: 20. Minimum value: 1. Maximum value: 50 |

### Queries the data progress list of ongoing and completed shard recoveries. By default, only ongoing shard…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-shard-recoveries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| activeOnly | string | no | Specifies whether to display shard data recovery tracking information. Valid values: true: Displays only ongoing shard data recovery… |

### Retrieves the list of cross-cluster OSS repository settings for the current instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-snapshot-repos-by-instance-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Aggregates event records
`GET https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/list-stats-event-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://elasticsearch.ap-southeast-1.aliyuncs.com |
| eventType | string | no | The event type |
| status | string | no | The event status |
| level | string | no | The event level |
| startTime | integer | no | The start time of the statistical window. The value is a UNIX timestamp in seconds. This parameter must be specified together with endTime |
| endTime | integer | no | The end time of the statistical window. The value is a UNIX timestamp in seconds. This parameter must be specified together with startTime… |

…and 87 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/activate-zones" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Elasticsearch API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-elasticsearch/activate-zones with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Elasticsearch API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Elasticsearch itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Elasticsearch API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-elasticsearch.

### What is the status of the Alibaba Cloud Elasticsearch API?
Needs your own provider key (bring your own key)