SingleStore Managed Service

list-regions
Description

Displays regions in which Managed Service clusters can be created.

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

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

For information on global flags, see Global Flags.

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 region objects is returned, depending on the organization to which the user belongs.

  • regionID UUID - The regionID of the region.

  • region string - Provides brief information about the region. For example, US West 1 (Oregon).

  • provider string - Specifies the provider within the region. For example, GCP.

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 regions that are available for cluster deployment.

singlestore list-regions
****
{
  "status": "success",
  "data": {
	"regions": [
  	{
    	"regionID": "1c1de314-2cc0-4c74-bd54-5047ff90842e",
    	"region": "US West 1 (Oregon)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "22a913e1-ace5-4362-afa0-3d21a01d6d1c",
    	"region": "US Central 1 (Iowa)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "3186a27b-87d5-4b84-a93b-90c57fd2be74",
    	"region": "Asia South 1 (Mumbai)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "35551562-6d39-4e14-8747-0f42114a330b",
    	"region": "Europe West 1 (Ireland)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "3de9e276-1c93-4987-9463-5700aa08a837",
    	"region": "US West 2 (Oregon)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "6de63e09-6a66-4846-9c43-cd866e906d36",
    	"region": "US East 1 (S. Carolina)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "7b9163df-67b0-45fb-985b-e571fbcb3792",
    	"region": "South America East 1 (Sao Paulo)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "7e7ffd27-20f7-44b6-87e6-e72828a81ac7",
    	"region": "Europe Central 1 (Frankfurt)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "7edebe18-2fdf-43c3-95b9-e4e83f17c756",
    	"region": "Europe West 4 (Netherlands)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "8d3fb71f-4eb8-4ca7-ae85-547cd98887c8",
    	"region": "East US 2 (Virginia)",
    	"provider": "Azure"
  	},
  	{
    	"regionID": "93b61160-0cae-4e11-a5de-977b8e2e3ee5",
    	"region": "US East 4 (N. Virginia)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "9939d0fb-e4f0-448c-b849-23121138e88a",
    	"region": "Europe North 1 (Finland)",
    	"provider": "GCP"
  	},
  	{
    	"regionID": "c04471f4-5d89-46e1-8d1e-76b8282ea0df",
    	"region": "Europe West 3 (Paris)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "c74bb6a6-0f14-4d56-bc80-1d874fa277b7",
    	"region": "Asia Pacific Southeast 2 (Sydney)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "df7d37c8-432e-4f3b-a54c-a69795ad2f44",
    	"region": "US East 1 (N. Virginia)",
    	"provider": "AWS"
  	},
  	{
    	"regionID": "ef8d7728-c25c-465c-bd4f-46aa728c01fc",
    	"region": "West Europe (Netherlands)",
    	"provider": "Azure"
  	}
	]
  }
}