Listing OpenSearch Clusters

View a list of the OpenSearch clusters in a Oracle Cloud Infrastructure compartment.

• Console
• CLI
• API

• 1. Open the navigation menu  and select Databases. Under OpenSearch, select Clusters.
     The Clusters list page opens. All clusters in the selected compartment are displayed in a table.
  2. To view the clusters in a different compartment, use the Compartment filter to switch compartments.

     You must have permission to work in a compartment to see the resources in it. If you're not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.

  Filtering List Results

  Use filters to limit the clusters in the list. Perform one of the following actions depending on the options that you see:

  • From the Search and Filter box above the list table, select one or more filters and specify the values that you want to use to narrow the list. In general, the filters correspond to the columns shown in the list table, although some filters represent attributes that aren't shown in the table. The Compartment filter is always displayed next to Applied filters.
  • On the left side of the list page, select a value from one of the available filters, such as compartment, state, or tags.

  Change the order of the items in the list table by using the sort icons next to the column names.

  Actions

  In the list table, select the name of a cluster to open its details page, where you can view its status and perform other tasks.

  To perform an action on a cluster directly from the list table, select any of the following options from the Actions menu () in the row for that cluster:

  • View details: Open the details page of the cluster.

  • Rename: Change the name of the cluster.

  • Create backup: Create a backup of the cluster.

  • Upgrade: Upgrade the software version of the cluster. You can also create a clone of the cluster and apply the upgrade to the cloned copy for testing.

  • Restore: Restore the cluster to a previous snapshot version and configuration.

  • Add Tags: Add tags to the pipeline.

  • Delete: Delete the cluster from your tenancy.

  To create a cluster, select Create cluster.

• Use the oci opensearch cluster list command and required parameters to list the clusters in a compartment:

  oci opensearch cluster list --compartment-id compartment_id [OPTIONS]

  For a complete list of parameters and values for CLI commands, see the CLI Command Reference.

• Run the ListOpensearchClusters operation to list the clusters in a compartment.