SingleStore Managed Service

list-clusters
Description

Displays the Managed Service clusters created in an organization.

Usage
singlestore list-clusters [FLAGS] [GLOBAL_FLAGS]
Flags

--cluster-id=clusterID - (Optional) The clusterID of the cluster to display. Skip this flag to view the list of all available clusters.

-h, --help - Help information for the singlestore list-clusters command.

--include-terminated - (Optional) Include terminated clusters in the list of clusters.

For information on global flags, see Global Flags.

Remarks
  • This command displays clusters in the organization that is mapped to the API key used. If you are a member of multiple organizations, make sure to set up the API key that corresponds to the right organization, and then run this command.

  • By default, this command outputs only clusters that are not terminated. Use the --include-terminated flag to list terminated clusters in addition to other clusters.

Output

The command outputs the following fields in JSON format.

status string - Indicates the status of the command execution, such as “success”, “fail”, or “error”. The command typically fails when the preconditions are not met. The “error” status usually indicates an API error.

data struct - If the command executes successfully, an array of the following cluster objects is returned, depending on the cluster information available.

  • name string - The cluster name specified during deployment.

  • clusterID UUID - A unique ID generated for the cluster during deployment.

  • region string - The region in which the cluster is deployed.

  • size float - The cluster size in decimals. For more information on cluster size and pricing, visit Managed Service Pricing.

  • state enum - The state of the cluster, such as Unspecified, PendingCreation, Transitioning, Active, Terminated, Suspending, Suspended, Resuming, and Failed.

  • version string - SingleStore DB version in Semantic Versioning (SemVer) format. For example, 7.5.8.

  • firewallRanges - Allowed IPs in CIDR notation. If no value is returned for this field, it indicates that the cluster can be reached from any IP address.

  • createdAt time - Cluster creation timestamp in UTC.

  • expiresAt time - Cluster expiration timestamp in UTC. If no value is returned for this field, the cluster is set to never expire.

  • terminatedAt time - Cluster termination timestamp in UTC. If no value is returned for this field, the cluster is not terminated.

Upon failure, the reason for the command failure is returned. This field is not returned if the status is “error”.

message string - This field is returned if the command status is “error”. A description of the API error is returned.

Examples

Display clusters that are not terminated

singlestore list-clusters
****
{
  "status": "success",
  "data": {
	"clusters": [
  	{
    	"name": "demo-cluster",
    	"clusterID": "7ed40b5b-7fe4-4718-bbc1-2d328e8e82b7",
    	"region": {
      	"regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
      	"region": "Asia Pacific Southeast 2 (Sydney)",
      	"provider": "AWS"
    	},
    	"size": "0.25",
    	"state": "Active",
    	"version": "7.5.11",
    	"createdAt": "2021-10-04T06:10:45Z"
  	},
  	{
    	"name": "sample-cluster",
    	"clusterID": "9456ba80-f7ab-4397-b495-d52593bc8dbe",
    	"region": {
      	"regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
      	"region": "Asia Pacific Southeast 2 (Sydney)",
      	"provider": "AWS"
    	},
    	"size": "1.0",
    	"state": "Transitioning",
    	"version": "7.5.11",
    	"firewallRanges": [
      	"192.168.0.1/32"
    	],
    	"createdAt": "2021-10-04T06:14:35Z",
    	"expiresAt": "2100-01-02T22:04:05Z"
  	}
  	]
  }
}

Display all clusters including terminated clusters

singlestore list-clusters --include-terminated
****
{
  "status": "success",
  "data": {
	"clusters": [
  	{
    	"name": "DevCluster_0",
    	"clusterID": "863a5311-f0af-426e-8e34-482a90c773ec",
    	"region": {
      	"regionID": "3de9e276-1c93-4987-9463-5700aa08a837",
      	"region": "US West 2 (Oregon)",
      	"provider": "AWS"
    	},
    	"size": "0.25",
    	"state": "Terminated",
    	"version": "7.5.9",
    	"createdAt": "2021-08-31T21:09:06Z",
    	"expiresAt": "2021-08-31T22:09:04Z",
    	"terminatedAt": "2021-08-31T21:15:14Z"
  	},
  	{
    	"name": "DevCluster_1",
    	"clusterID": "3667ab27-55e3-47f9-8b55-a4fab00051f9",
    	"region": {
      	"regionID": "df7d37c8-432e-4f3b-a54c-a69795ad2f44",
      	"region": "US East 1 (N. Virginia)",
      	"provider": "AWS"
    	},
    	"size": "0.25",
    	"state": "Terminated",
    	"version": "7.5.9",
    	"createdAt": "2021-08-31T21:10:30Z",
    	"expiresAt": "2021-08-31T23:10:30Z",
    	"terminatedAt": "2021-08-31T21:53:35Z"
  	},
            {
            "name": "demo-cluster",
            "clusterID": "7ed40b5b-7fe4-4718-bbc1-2d328e8e82b7",
            "region": {
            "regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
            "region": "Asia Pacific Southeast 2 (Sydney)",
            "provider": "AWS"
            },
            "size": "0.25",
            "state": "Active",
            "version": "7.5.11",
            "createdAt": "2021-10-04T06:10:45Z"
            },
            {
            "name": "sample-cluster",
            "clusterID": "9456ba80-f7ab-4397-b495-d52593bc8dbe",
            "region": {
            "regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
            "region": "Asia Pacific Southeast 2 (Sydney)",
            "provider": "AWS"
            },
            "size": "1.0",
            "state": "Active",
            "version": "7.5.11",
            "firewallRanges": [
            "192.168.0.1/32"
            ],
            "createdAt": "2021-10-04T06:14:35Z",
            "expiresAt": "2100-01-02T22:04:05Z"
            }
            ]
 }
}

Display information about a cluster.

singlestore list-clusters --cluster-id 9456ba80-f7ab-4397-b495-d52593bc8dbe
****
{
  "status": "success",
  "data": {
	"clusters": [
  	{
    	"name": "sample-cluster",
    	"clusterID": "9456ba80-f7ab-4397-b495-d52593bc8dbe",
    	"region": {
      	"regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
      	"region": "Asia Pacific Southeast 2 (Sydney)",
      	"provider": "AWS"
    	},
    	"size": "1.0",
    	"state": "Active",
    	"version": "7.5.11",
    	"firewallRanges": [
      	"192.168.0.1/32"
    	],
    	"createdAt": "2021-10-04T06:14:35Z",
    	"expiresAt": "2100-01-02T22:04:05Z"
  	}
	]
  }
}