SingleStore Managed Service

resume-cluster
Description

Resumes a suspended Managed Service cluster in an organization.

Usage
singlestore resume-cluster --cluster-id [FLAGS] [GLOBAL_FLAG]
Flags

--cluster-id=clusterID - The clusterID of the cluster that needs to be resumed. To find the list of clusters and their IDs, run singlestore list-clusters.

-h, --help - Help information for the singlestore resume-cluster command.

For information on global flags, see Global Flags.

Remarks
  • Only unlimited storage clusters can be suspended and resumed, which are clusters created in a region that supports unlimited storage. Otherwise, the cluster is a standard cluster that cannot be suspended or resumed.

  • This command can only resume clusters in the organization that is mapped to the API key used. To resume a cluster in a different organization, set up the respective API key before running this command.

  • When a cluster is resumed, it may take some time to reach the “Active” state. Run singlestore list-clusters --cluster-id <clusterID> to view the cluster state.

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, the clusterID of the resumed cluster is returned. Upon failure, the reason for the command failure is returned. No data is 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

Resume a suspended cluster.

singlestore resume-cluster --cluster-id 9456ba80-f7ab-4397-b495-d52593bc8dbe
****
{
  "status": "success",
  "data": {
	"clusterID": "9456ba80-f7ab-4397-b495-d52593bc8dbe"
  }
}

The cluster may take some time to be up and running. You can verify the cluster state using the following command:

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": "Resuming",
    	"version": "7.5.11",
    	"firewallRanges": [
      	"192.168.0.1/32"
    	],
    	"createdAt": "2021-10-04T06:14:35Z",
    	"expiresAt": "2100-01-02T22:04:05Z"
  	}
	]
  }
}

When the cluster resumes, it will attain the “Active” state as shown below:

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"
  	}
	]
  }
}