All Products
Search
Document Center

Elasticsearch:View the basic information of a cluster

Last Updated:Oct 15, 2024

You can obtain the basic information of an Elasticsearch cluster from the Basic Information page of the cluster. The information includes the internal or public endpoint, port number, version, and type of the cluster. This topic describes the information displayed on the Basic Information page.

Procedure

  1. Log on to the Alibaba Cloud Elasticsearch console.
  2. In the left-side navigation pane, click Elasticsearch Clusters.
  3. Navigate to the desired cluster.
    1. In the top navigation bar, select the resource group to which the cluster belongs and the region where the cluster resides.
    2. On the Elasticsearch Clusters page, find the cluster and click its ID.
  4. On the Basic Information page, view the basic information and statistics of the cluster.

    Note

    The following table describes only significant information. The actual information in the console prevails.

    Section

    Parameter

    Description

    Basic Information

    Cluster ID

    The unique ID of the cluster.

    Name

    By default, the cluster name is the same as the cluster ID. Cluster names are configurable. You can search for clusters by name.

    Version

    The version of the cluster, such as 5.5, 5.6, 6.3, 6.7, 6.8, 7.7, 7.10, 7.16, 8.5, 8.9, 8.13, and 8.15.

    Note

    If you want to upgrade the version of the cluster, you can use the version upgrade feature of Elasticsearch. For more information, see Upgrade the version of a cluster.

    Cluster Type

    The type of the cluster. Valid values: Vector Enhanced Edition, Kernel-enhanced Edition, and Standard Edition.

    Region

    The region where the cluster resides.

    Zone

    The zone where the cluster resides.

    VPC

    The ID of the virtual private cloud (VPC) to which the cluster belongs.

    vSwitch ID

    The ID of the vSwitch to which the cluster belongs.

    Internal Endpoint

    The internal endpoint of the cluster. In a VPC, you can use an Elastic Compute Service (ECS) instance to connect to the internal endpoint of an Elasticsearch cluster.

    Important

    For security and stability purposes, we recommend that you do not access an Elasticsearch cluster over the Internet. If you require high security and stability, purchase an ECS instance in the VPC where your Elasticsearch cluster resides and use the ECS instance to connect to the internal endpoint of the Elasticsearch cluster.

    Internal Port

    Elasticsearch supports the following ports:

    • Port 9200 for HTTP and HTTPS.

    • Port 9300 for TCP. Only Elasticsearch V5.X clusters support this port.

      Note

      You cannot use Transport Client to access Elasticsearch clusters of V6.0 or later over port 9300. If you want to use port 9300, purchase a V5.X cluster. For more information about how to access a cluster, see Access and configure an Elasticsearch cluster.

    Public Endpoint

    The public endpoint of the cluster. You can use this endpoint to access the cluster over the Internet. Before you use this endpoint, you must turn on Public Network Access on the Security page. For more information, see Configure a public or private IP address whitelist for an Elasticsearch cluster.

    Important

    If you use the public endpoint to access the Elasticsearch cluster, you must configure a public IP address whitelist for the cluster. By default, all IP addresses cannot be used to access the cluster over the Internet. For more information about how to configure the whitelist, see Configure a public IP address whitelist for an Elasticsearch cluster.

    Public Port

    The port used to connect to the cluster over the Internet. This parameter is displayed only after you turn on Public Network Access. Elasticsearch supports the following ports:

    • Port 9200 for HTTP and HTTPS.

    • Port 9300 for TCP. Only Elasticsearch V5.X clusters support this port.

      Note

      You cannot use Transport Client to access Elasticsearch clusters of V6.0 or later over port 9300. If you want to use port 9300, purchase a V5.X cluster. For more information about how to access a cluster, see Access and configure an Elasticsearch cluster.

    Protocol

    The protocol used by the cluster. Default value: HTTP. Valid values: HTTP and HTTPS. For more information, see Enable HTTPS.

    Resource Group Name

    The name of the resource group to which the cluster belongs. For more information, see Create a resource group.

    Resource Group ID

    The ID of the resource group to which the cluster belongs. For more information, see Create a resource group.

    Tag

    The tags added to the cluster. You can use tags to classify and manage Elasticsearch clusters. For more information, see Manage cluster tags.

    Cluster Statistics

    Status

    The status of the cluster. An Elasticsearch cluster has the following states: Normal (indicated by the color green), Initializing (indicated by the color yellow), Paused (indicated by the color red), and Expired (indicated by the color gray).

    Billing Method

    The billing method of the cluster. Valid values: Pay-as-you-go and Subscription.

    Created At

    The time when the cluster is created.

    Maintenance Window

    The maintenance window for the cluster. The default value of this parameter is 02:00 - 06:00. You can configure Maintenance Window based on your business requirements. For more information, see Set a maintenance window.

    Note
    • If you want to renew a subscription cluster, click Renew on the right side of the Basic Information page. The minimum renewal period of a cluster is one month. For more information, see Renew a cluster.

    • If you want to switch the billing method of a cluster from pay-as-you-go to subscription, click Switch to Subscription on the right side of the Basic Information page. No discounts are offered when you switch the billing method. For more information, see Switch the billing method of a cluster from pay-as-you-go to subscription.

References

DescribeInstance