List PCU groups

Lists all Provisioned Capacity Units (PCUs) in an organization.

You need an application token with the Organization Administrator or Billing Administrator role.

For more information, see Get endpoint and token.

Result

Returns an unordered list of PCUGroupDescriptor objects. Each object describes a PCU group in the organization.

Returns a promise that resolves to an unordered list of AstraPCUGroupDescriptor objects. Each object describes a PCU group in the organization.

The Go client is in preview. For more information, see astra-db-go.

Returns an unordered slice of PCUGroup structs. Each struct describes a PCU group in the organization.

Returns an unordered list of PCUGroupDefinition objects. Each object describes a PCU group in the organization.

Returns an unordered list of DataStax.AstraDB.DataApi.Admin.PCUGroup objects. Each object describes a PCU group in the organization.

Returns an unordered list of JSON objects. Each object describes a PCU group in the organization.

Name	Type	Summary
`cloud_provider`	`str`	Required if you specify `region`. Only returns PCU groups for this cloud provider. Can be one of: `aws`, `gcp`, `azure`.
`region`	`str`	Required if you specify `cloud_provider`. Only returns PCU groups in this cloud provider region. The available regions depend on your plan and the database type. To find available regions, see Find available regions.
`database_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `AstraDBAdmin` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

Name	Type	Summary
`options`	`ListAstraPCUGroupsOptions`	Optional. The options for this operation. See Properties of `options` for more details.

Properties of `options`
Name	Type	Summary
`cloudProvider`	`AstraDatabaseCloudProvider`	Required if you specify `region`. Only returns PCU groups for this cloud provider.
`region`	`string`	Required if you specify `cloudProvider`. Only returns PCU groups in this cloud provider region. The available regions depend on your plan and the database type. To find available regions, see Find available regions.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

Name	Type	Summary
`ctx`	`context.Context`	The context for the operation.
`opts`	`…options.ListPCUGroupsOption`	Optional. A builder to generate options for this operation. See Methods of the `ListPCUGroupsOption` builder for more details.

Methods of the `ListPCUGroupsOption` builder
Method	Summary
`SetCloudProvider(v options.CloudProvider)`	Required if you specify `SetRegion()`. Only returns PCU groups for this cloud provider.
`SetRegion(v string)`	Required if you specify `SetCloudProvider()`. Only returns PCU groups in this cloud provider region. The available regions depend on your plan and the database type. To find available regions, see Find available regions.
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Name	Type	Summary
`cloudProvider`	`CloudProviderType`	Only returns PCU groups for this cloud provider.
`region`	`String`	Only returns PCU groups in this cloud provider region. The available regions depend on your plan and the database type. To find available regions, see Find available regions.

Name	Type	Summary
`options`	`ListPCUGroupsOptions`	Optional. General API options for this operation, including the timeout. For more information and examples, see Customize API interaction. For options specific to this method, see Method-specific properties of the `ListPCUGroupsOptions` class.

Method-specific properties of the `ListPCUGroupsOptions` class
Name	Type	Summary
`CloudProvider`	`CloudProviderType`	Required if you specify `Region`. Only returns PCU groups for this cloud provider.
`Region`	`string`	Required if you specify `CloudProvider`. Only returns PCU groups in this cloud provider region. The available regions depend on your plan and the database type. To find available regions, see Find available regions.

The application token must have sufficient permissions to perform the requested operations, such as the Organization Administrator role. Additionally, the application token identifies the organization to query.

Command signature

curl -sS -L -X GET "https://api.astra.datastax.com/v2/pcus/actions/get" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"

This endpoint does not accept any parameters.

Examples

The following examples demonstrate how to list PCU groups.

List all PCU groups

from astrapy import DataAPIClient

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

groups = admin.list_pcu_groups()

print(groups)

import { DataAPIClient } from "@datastax/astra-db-ts";

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  const groups = await admin.listPCUGroups();

  console.log(groups);
})();

The Go client is in preview. For more information, see astra-db-go.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/options"
)

func main() {
	ctx := context.Background()

	client := astra.NewClient(
		options.API().SetToken("APPLICATION_TOKEN"),
	)

	admin, err := client.Admin()

	if err != nil {
		log.Fatal(err)
	}

	groups, err := admin.ListPCUGroups(ctx)

	if err != nil {
		log.Fatal(err)
	}

	output, err := json.Marshal(groups)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(output))
}

import java.util.List;

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.AstraDBAdmin;
import com.datastax.astra.client.admin.definition.PCUGroupDefinition;

public class Example {
  public static void main(String[] args) {
    DataAPIClient client = new DataAPIClient("APPLICATION_TOKEN");

    AstraDBAdmin admin = client.getAdmin();

    List<PCUGroupDefinition> groups = admin.listPCUGroups();

    System.out.println(groups);
  }
}

using System.Text.Json;
using DataStax.AstraDB.DataApi;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    var client = new DataAPIClient("APPLICATION_TOKEN");

    var admin = client.GetAstraDatabasesAdmin();

    var groups = await admin.ListPCUGroupsAsync();

    Console.WriteLine(JsonSerializer.Serialize(groups));
  }
}

curl -sS -L -X GET "https://api.astra.datastax.com/v2/pcus/actions/get" \
  --header "Authorization: Bearer APPLICATION_TOKEN" \
  --header "Content-Type: application/json"

List PCU groups for a cloud provider region

from astrapy import DataAPIClient

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

groups = admin.list_pcu_groups(cloud_provider="aws", region="us-west-2")

print(groups)

import { DataAPIClient,AstraDatabaseCloudProvider } from "@datastax/astra-db-ts";

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  const groups = await admin.listPCUGroups({
    cloudProvider: "AWS",
    region: "us-west-2",
  });

  console.log(groups);
})();

The Go client is in preview. For more information, see astra-db-go.

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"

	"github.com/datastax/astra-db-go/v2/astra"
	"github.com/datastax/astra-db-go/v2/astra/options"
)

func main() {
	ctx := context.Background()

	client := astra.NewClient(
		options.API().SetToken("APPLICATION_TOKEN"),
	)

	admin, err := client.Admin()

	if err != nil {
		log.Fatal(err)
	}

	groups, err := admin.ListPCUGroups(
		ctx,
		options.ListPCUGroups().
			SetCloudProvider(options.CloudProviderAWS).
			SetRegion("us-west-2"),
	)

	if err != nil {
		log.Fatal(err)
	}

	output, err := json.Marshal(groups)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(output))
}

import java.util.List;

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.AstraDBAdmin;
import com.datastax.astra.client.admin.definition.PCUGroupDefinition;
import com.dtsx.astra.sdk.db.domain.CloudProviderType;

public class Example {
  public static void main(String[] args) {
    DataAPIClient client = new DataAPIClient("APPLICATION_TOKEN");

    AstraDBAdmin admin = client.getAdmin();

    List<PCUGroupDefinition> groups = admin.listPCUGroups(CloudProviderType.AWS, "us-east-2");

    System.out.println(groups);
  }
}

using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Admin;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    var client = new DataAPIClient("APPLICATION_TOKEN");

    var admin = client.GetAstraDatabasesAdmin();

    var groups = await admin.ListPCUGroupsAsync(
      new ListPCUGroupsOptions
      {
        CloudProvider = CloudProviderType.AWS,
        Region = "us-east-2",
      }
    );

    Console.WriteLine(JsonSerializer.Serialize(groups));
  }
}

This endpoint does not accept parameters to limit by cloud provider regions. Instead, you can list all PCU groups, and then extract the desired values from the response.

Client reference

For more information, see the client reference.

The Go client is in preview. For more information, see astra-db-go.

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

List PCU groups

Result

Parameters

Examples

List all PCU groups

List PCU groups for a cloud provider region

Client reference

Was this helpful?

Give Feedback