Find available regions (C#)
Gets a list of available regions for database creation.
The clients only return regions that support vector databases.
To return other regions, use a direct HTTP request with the region-type query parameter.
|
You need an application token with permission to create and configure databases, such as the Organization Administrator role. For more information, see Get endpoint and token. |
Result
Returns a list of RegionInfo objects that contain information about the available regions.
Parameters
Use the FindAvailableRegionsAsync method, which belongs to the AstraDatabasesAdmin class.
You can also use FindAvailableRegions, which is the synchronous version of the method.
Method signature
public Task<List<RegionInfo>> FindAvailableRegionsAsync(
FindAvailableRegionsOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
Optional.
Options for this operation.
For more information and examples for general options such as timeout, see Customize API interaction.
For options specific to this method, see Method-specific properties of the |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether to only return regions that can be used by the caller’s organization. Default: true |
Examples
The following examples demonstrate how to find available regions.
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
var client = new DataAPIClient("APPLICATION_TOKEN");
var admin = client.GetAstraDatabasesAdmin();
var regions = await admin.FindAvailableRegionsAsync();
}
}Client reference
For more information, see the client reference.
