List PCU groups (Go)

Lists all Provisioned Capacity Units (PCU) groups 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 slice of PCUGroup structs. Each struct describes a PCU group in the organization.

Parameters

Use the ListPCUGroups method, which belongs to the AstraAdmin type.

Method signature

func (a *AstraAdmin) ListPCUGroups(
  ctx context.Context,
  opts ...options.ListPCUGroupsOption
) ([]PCUGroup, error)

Name Type Summary

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.

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 (Go).
`UpdateAPIOptions(v …APIOption)`	Optional. General API options for this operation, including the timeout.

Examples

The following examples demonstrate how to list PCU groups.

List all PCU groups

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))
}

List PCU groups for a cloud provider region

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))
}

Client reference

For more information, see the client reference.