1. Packages
  2. Volcengine
  3. API Docs
  4. bioos
  5. getClusters
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.bioos.getClusters

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of bioos clusters

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.bioos.getClusters({});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.bioos.get_clusters()

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/bioos"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bioos.GetClusters(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Bioos.GetClusters.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.bioos.BioosFunctions;
import com.pulumi.volcengine.bioos.inputs.GetClustersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = BioosFunctions.getClusters();

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:bioos:getClusters
      Arguments: {}

    Using getClusters

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>
    def get_clusters(ids: Optional[Sequence[str]] = None,
                 output_file: Optional[str] = None,
                 public: Optional[bool] = None,
                 statuses: Optional[Sequence[str]] = None,
                 types: Optional[Sequence[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 output_file: Optional[pulumi.Input[str]] = None,
                 public: Optional[pulumi.Input[bool]] = None,
                 statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
    func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

    > Note: This function is named GetClusters in the Go SDK.

    public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
public static Output<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:bioos/getClusters:getClusters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of cluster ids.
    OutputFile string
    File name where to save data source results.
    Public bool
    whether it is a public cluster.
    Statuses List<string>
    The status of the clusters.
    Types List<string>
    The type of the clusters.
    Ids []string
    A list of cluster ids.
    OutputFile string
    File name where to save data source results.
    Public bool
    whether it is a public cluster.
    Statuses []string
    The status of the clusters.
    Types []string
    The type of the clusters.
    ids List<String>
    A list of cluster ids.
    outputFile String
    File name where to save data source results.
    public_ Boolean
    whether it is a public cluster.
    statuses List<String>
    The status of the clusters.
    types List<String>
    The type of the clusters.
    ids string[]
    A list of cluster ids.
    outputFile string
    File name where to save data source results.
    public boolean
    whether it is a public cluster.
    statuses string[]
    The status of the clusters.
    types string[]
    The type of the clusters.
    ids Sequence[str]
    A list of cluster ids.
    output_file str
    File name where to save data source results.
    public bool
    whether it is a public cluster.
    statuses Sequence[str]
    The status of the clusters.
    types Sequence[str]
    The type of the clusters.
    ids List<String>
    A list of cluster ids.
    outputFile String
    File name where to save data source results.
    public Boolean
    whether it is a public cluster.
    statuses List<String>
    The status of the clusters.
    types List<String>
    The type of the clusters.

    getClusters Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Items List<GetClustersItem>
    The list of clusters.
    TotalCount int
    The total count of Cluster query.
    Ids List<string>
    OutputFile string
    Public bool
    whether it is a public cluster.
    Statuses List<string>
    The status of the cluster.
    Types List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    Items []GetClustersItem
    The list of clusters.
    TotalCount int
    The total count of Cluster query.
    Ids []string
    OutputFile string
    Public bool
    whether it is a public cluster.
    Statuses []string
    The status of the cluster.
    Types []string
    id String
    The provider-assigned unique ID for this managed resource.
    items List<GetClustersItem>
    The list of clusters.
    totalCount Integer
    The total count of Cluster query.
    ids List<String>
    outputFile String
    public_ Boolean
    whether it is a public cluster.
    statuses List<String>
    The status of the cluster.
    types List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    items GetClustersItem[]
    The list of clusters.
    totalCount number
    The total count of Cluster query.
    ids string[]
    outputFile string
    public boolean
    whether it is a public cluster.
    statuses string[]
    The status of the cluster.
    types string[]
    id str
    The provider-assigned unique ID for this managed resource.
    items Sequence[GetClustersItem]
    The list of clusters.
    total_count int
    The total count of Cluster query.
    ids Sequence[str]
    output_file str
    public bool
    whether it is a public cluster.
    statuses Sequence[str]
    The status of the cluster.
    types Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    items List<Property Map>
    The list of clusters.
    totalCount Number
    The total count of Cluster query.
    ids List<String>
    outputFile String
    public Boolean
    whether it is a public cluster.
    statuses List<String>
    The status of the cluster.
    types List<String>

    Supporting Types

    GetClustersItem

    Bound bool
    Whether there is a bound workspace.
    Description string
    The description of the cluster.
    Id string
    The id of the bioos cluster.
    Name string
    The name of the cluster.
    Public bool
    whether it is a public cluster.
    SharedConfigs List<GetClustersItemSharedConfig>
    The configuration of the shared cluster.
    StartTime int
    The start time of the cluster.
    Status string
    The status of the clusters.
    StoppedTime int
    The end time of the cluster.
    VkeConfigId string
    The id of the vke cluster.
    VkeConfigStorageClass string
    The name of the StorageClass that the vke cluster has installed.
    Bound bool
    Whether there is a bound workspace.
    Description string
    The description of the cluster.
    Id string
    The id of the bioos cluster.
    Name string
    The name of the cluster.
    Public bool
    whether it is a public cluster.
    SharedConfigs []GetClustersItemSharedConfig
    The configuration of the shared cluster.
    StartTime int
    The start time of the cluster.
    Status string
    The status of the clusters.
    StoppedTime int
    The end time of the cluster.
    VkeConfigId string
    The id of the vke cluster.
    VkeConfigStorageClass string
    The name of the StorageClass that the vke cluster has installed.
    bound Boolean
    Whether there is a bound workspace.
    description String
    The description of the cluster.
    id String
    The id of the bioos cluster.
    name String
    The name of the cluster.
    public_ Boolean
    whether it is a public cluster.
    sharedConfigs List<GetClustersItemSharedConfig>
    The configuration of the shared cluster.
    startTime Integer
    The start time of the cluster.
    status String
    The status of the clusters.
    stoppedTime Integer
    The end time of the cluster.
    vkeConfigId String
    The id of the vke cluster.
    vkeConfigStorageClass String
    The name of the StorageClass that the vke cluster has installed.
    bound boolean
    Whether there is a bound workspace.
    description string
    The description of the cluster.
    id string
    The id of the bioos cluster.
    name string
    The name of the cluster.
    public boolean
    whether it is a public cluster.
    sharedConfigs GetClustersItemSharedConfig[]
    The configuration of the shared cluster.
    startTime number
    The start time of the cluster.
    status string
    The status of the clusters.
    stoppedTime number
    The end time of the cluster.
    vkeConfigId string
    The id of the vke cluster.
    vkeConfigStorageClass string
    The name of the StorageClass that the vke cluster has installed.
    bound bool
    Whether there is a bound workspace.
    description str
    The description of the cluster.
    id str
    The id of the bioos cluster.
    name str
    The name of the cluster.
    public bool
    whether it is a public cluster.
    shared_configs Sequence[GetClustersItemSharedConfig]
    The configuration of the shared cluster.
    start_time int
    The start time of the cluster.
    status str
    The status of the clusters.
    stopped_time int
    The end time of the cluster.
    vke_config_id str
    The id of the vke cluster.
    vke_config_storage_class str
    The name of the StorageClass that the vke cluster has installed.
    bound Boolean
    Whether there is a bound workspace.
    description String
    The description of the cluster.
    id String
    The id of the bioos cluster.
    name String
    The name of the cluster.
    public Boolean
    whether it is a public cluster.
    sharedConfigs List<Property Map>
    The configuration of the shared cluster.
    startTime Number
    The start time of the cluster.
    status String
    The status of the clusters.
    stoppedTime Number
    The end time of the cluster.
    vkeConfigId String
    The id of the vke cluster.
    vkeConfigStorageClass String
    The name of the StorageClass that the vke cluster has installed.

    GetClustersItemSharedConfig

    Enable bool
    Whether to enable a shared cluster. This value must be true.
    Enable bool
    Whether to enable a shared cluster. This value must be true.
    enable Boolean
    Whether to enable a shared cluster. This value must be true.
    enable boolean
    Whether to enable a shared cluster. This value must be true.
    enable bool
    Whether to enable a shared cluster. This value must be true.
    enable Boolean
    Whether to enable a shared cluster. This value must be true.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate