tencentcloud 1.82.34, Nov 5 25

tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCbsStorages

Start a Neo task

Explain and create a tencentcloud.getCbsStorages resource

tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

Query all CBS storages

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

const example = tencentcloud.getCbsStorages({});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_cbs_storages()

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetCbsStorages(ctx, &tencentcloud.GetCbsStoragesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCbsStorages.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCbsStoragesArgs;
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 example = TencentcloudFunctions.getCbsStorages(GetCbsStoragesArgs.builder()
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getCbsStorages
      arguments: {}

Query CBS by storage id

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

const example = tencentcloud.getCbsStorages({
    storageId: "disk-6goq404g",
    resultOutputFile: "my-test-path",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_cbs_storages(storage_id="disk-6goq404g",
    result_output_file="my-test-path")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetCbsStorages(ctx, &tencentcloud.GetCbsStoragesArgs{
			StorageId:        pulumi.StringRef("disk-6goq404g"),
			ResultOutputFile: pulumi.StringRef("my-test-path"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCbsStorages.Invoke(new()
    {
        StorageId = "disk-6goq404g",
        ResultOutputFile = "my-test-path",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCbsStoragesArgs;
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 example = TencentcloudFunctions.getCbsStorages(GetCbsStoragesArgs.builder()
            .storageId("disk-6goq404g")
            .resultOutputFile("my-test-path")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getCbsStorages
      arguments:
        storageId: disk-6goq404g
        resultOutputFile: my-test-path

Query CBS by dedicated cluster id

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

const example = tencentcloud.getCbsStorages({
    dedicatedClusterId: "cluster-262n63e8",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_cbs_storages(dedicated_cluster_id="cluster-262n63e8")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetCbsStorages(ctx, &tencentcloud.GetCbsStoragesArgs{
			DedicatedClusterId: pulumi.StringRef("cluster-262n63e8"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCbsStorages.Invoke(new()
    {
        DedicatedClusterId = "cluster-262n63e8",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCbsStoragesArgs;
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 example = TencentcloudFunctions.getCbsStorages(GetCbsStoragesArgs.builder()
            .dedicatedClusterId("cluster-262n63e8")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getCbsStorages
      arguments:
        dedicatedClusterId: cluster-262n63e8

The following snippet shows the new supported query params

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

const example = tencentcloud.getCbsStorages({
    chargeTypes: [
        "POSTPAID_BY_HOUR",
        "PREPAID",
        "CDCPAID",
        "DEDICATED_CLUSTER_PAID",
    ],
    storageStates: ["ATTACHED"],
    instanceIps: ["10.0.0.2"],
    instanceNames: ["my-instance"],
    tagKeys: ["example"],
    tagValues: [
        "bar",
        "baz",
    ],
    portable: true,
});

import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_cbs_storages(charge_types=[
        "POSTPAID_BY_HOUR",
        "PREPAID",
        "CDCPAID",
        "DEDICATED_CLUSTER_PAID",
    ],
    storage_states=["ATTACHED"],
    instance_ips=["10.0.0.2"],
    instance_names=["my-instance"],
    tag_keys=["example"],
    tag_values=[
        "bar",
        "baz",
    ],
    portable=True)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetCbsStorages(ctx, &tencentcloud.GetCbsStoragesArgs{
			ChargeTypes: []string{
				"POSTPAID_BY_HOUR",
				"PREPAID",
				"CDCPAID",
				"DEDICATED_CLUSTER_PAID",
			},
			StorageStates: []string{
				"ATTACHED",
			},
			InstanceIps: []string{
				"10.0.0.2",
			},
			InstanceNames: []string{
				"my-instance",
			},
			TagKeys: []string{
				"example",
			},
			TagValues: []string{
				"bar",
				"baz",
			},
			Portable: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Tencentcloud.GetCbsStorages.Invoke(new()
    {
        ChargeTypes = new[]
        {
            "POSTPAID_BY_HOUR",
            "PREPAID",
            "CDCPAID",
            "DEDICATED_CLUSTER_PAID",
        },
        StorageStates = new[]
        {
            "ATTACHED",
        },
        InstanceIps = new[]
        {
            "10.0.0.2",
        },
        InstanceNames = new[]
        {
            "my-instance",
        },
        TagKeys = new[]
        {
            "example",
        },
        TagValues = new[]
        {
            "bar",
            "baz",
        },
        Portable = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetCbsStoragesArgs;
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 example = TencentcloudFunctions.getCbsStorages(GetCbsStoragesArgs.builder()
            .chargeTypes(            
                "POSTPAID_BY_HOUR",
                "PREPAID",
                "CDCPAID",
                "DEDICATED_CLUSTER_PAID")
            .storageStates("ATTACHED")
            .instanceIps("10.0.0.2")
            .instanceNames("my-instance")
            .tagKeys("example")
            .tagValues(            
                "bar",
                "baz")
            .portable(true)
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: tencentcloud:getCbsStorages
      arguments:
        chargeTypes:
          - POSTPAID_BY_HOUR
          - PREPAID
          - CDCPAID
          - DEDICATED_CLUSTER_PAID
        storageStates:
          - ATTACHED
        instanceIps:
          - 10.0.0.2
        instanceNames:
          - my-instance
        tagKeys:
          - example
        tagValues:
          - bar
          - baz
        portable: true

Using getCbsStorages

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 getCbsStorages(args: GetCbsStoragesArgs, opts?: InvokeOptions): Promise<GetCbsStoragesResult>
function getCbsStoragesOutput(args: GetCbsStoragesOutputArgs, opts?: InvokeOptions): Output<GetCbsStoragesResult>

def get_cbs_storages(availability_zone: Optional[str] = None,
                     charge_types: Optional[Sequence[str]] = None,
                     dedicated_cluster_id: Optional[str] = None,
                     id: Optional[str] = None,
                     instance_ips: Optional[Sequence[str]] = None,
                     instance_names: Optional[Sequence[str]] = None,
                     portable: Optional[bool] = None,
                     project_id: Optional[float] = None,
                     result_output_file: Optional[str] = None,
                     storage_id: Optional[str] = None,
                     storage_name: Optional[str] = None,
                     storage_states: Optional[Sequence[str]] = None,
                     storage_type: Optional[str] = None,
                     storage_usage: Optional[str] = None,
                     tag_keys: Optional[Sequence[str]] = None,
                     tag_values: Optional[Sequence[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetCbsStoragesResult
def get_cbs_storages_output(availability_zone: Optional[pulumi.Input[str]] = None,
                     charge_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     dedicated_cluster_id: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     instance_ips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     instance_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     portable: Optional[pulumi.Input[bool]] = None,
                     project_id: Optional[pulumi.Input[float]] = None,
                     result_output_file: Optional[pulumi.Input[str]] = None,
                     storage_id: Optional[pulumi.Input[str]] = None,
                     storage_name: Optional[pulumi.Input[str]] = None,
                     storage_states: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     storage_type: Optional[pulumi.Input[str]] = None,
                     storage_usage: Optional[pulumi.Input[str]] = None,
                     tag_keys: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     tag_values: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetCbsStoragesResult]

func GetCbsStorages(ctx *Context, args *GetCbsStoragesArgs, opts ...InvokeOption) (*GetCbsStoragesResult, error)
func GetCbsStoragesOutput(ctx *Context, args *GetCbsStoragesOutputArgs, opts ...InvokeOption) GetCbsStoragesResultOutput

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

public static class GetCbsStorages 
{
    public static Task<GetCbsStoragesResult> InvokeAsync(GetCbsStoragesArgs args, InvokeOptions? opts = null)
    public static Output<GetCbsStoragesResult> Invoke(GetCbsStoragesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCbsStoragesResult> getCbsStorages(GetCbsStoragesArgs args, InvokeOptions options)
public static Output<GetCbsStoragesResult> getCbsStorages(GetCbsStoragesArgs args, InvokeOptions options)

fn::invoke:
  function: tencentcloud:index/getCbsStorages:getCbsStorages
  arguments:
    # arguments dictionary

The following arguments are supported:

AvailabilityZone string: The available zone that the CBS instance locates at.
ChargeTypes List<string>: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
DedicatedClusterId string: Exclusive cluster id.
Id string
InstanceIps List<string>: List filter by attached instance public or private IPs.
InstanceNames List<string>: List filter by attached instance name.
Portable bool: Filter by whether the disk is portable (Boolean true or false).
ProjectId double: ID of the project with which the CBS is associated.
ResultOutputFile string: Used to save results.
StorageId string: ID of the CBS to be queried.
StorageName string: Name of the CBS to be queried.
StorageStates List<string>: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
StorageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
StorageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
TagKeys List<string>: List filter by tag keys.
TagValues List<string>: List filter by tag values.

AvailabilityZone string: The available zone that the CBS instance locates at.
ChargeTypes []string: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
DedicatedClusterId string: Exclusive cluster id.
Id string
InstanceIps []string: List filter by attached instance public or private IPs.
InstanceNames []string: List filter by attached instance name.
Portable bool: Filter by whether the disk is portable (Boolean true or false).
ProjectId float64: ID of the project with which the CBS is associated.
ResultOutputFile string: Used to save results.
StorageId string: ID of the CBS to be queried.
StorageName string: Name of the CBS to be queried.
StorageStates []string: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
StorageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
StorageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
TagKeys []string: List filter by tag keys.
TagValues []string: List filter by tag values.

availabilityZone String: The available zone that the CBS instance locates at.
chargeTypes List<String>: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
dedicatedClusterId String: Exclusive cluster id.
id String
instanceIps List<String>: List filter by attached instance public or private IPs.
instanceNames List<String>: List filter by attached instance name.
portable Boolean: Filter by whether the disk is portable (Boolean true or false).
projectId Double: ID of the project with which the CBS is associated.
resultOutputFile String: Used to save results.
storageId String: ID of the CBS to be queried.
storageName String: Name of the CBS to be queried.
storageStates List<String>: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
storageType String: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage String: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tagKeys List<String>: List filter by tag keys.
tagValues List<String>: List filter by tag values.

availabilityZone string: The available zone that the CBS instance locates at.
chargeTypes string[]: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
dedicatedClusterId string: Exclusive cluster id.
id string
instanceIps string[]: List filter by attached instance public or private IPs.
instanceNames string[]: List filter by attached instance name.
portable boolean: Filter by whether the disk is portable (Boolean true or false).
projectId number: ID of the project with which the CBS is associated.
resultOutputFile string: Used to save results.
storageId string: ID of the CBS to be queried.
storageName string: Name of the CBS to be queried.
storageStates string[]: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
storageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tagKeys string[]: List filter by tag keys.
tagValues string[]: List filter by tag values.

availability_zone str: The available zone that the CBS instance locates at.
charge_types Sequence[str]: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
dedicated_cluster_id str: Exclusive cluster id.
id str
instance_ips Sequence[str]: List filter by attached instance public or private IPs.
instance_names Sequence[str]: List filter by attached instance name.
portable bool: Filter by whether the disk is portable (Boolean true or false).
project_id float: ID of the project with which the CBS is associated.
result_output_file str: Used to save results.
storage_id str: ID of the CBS to be queried.
storage_name str: Name of the CBS to be queried.
storage_states Sequence[str]: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
storage_type str: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storage_usage str: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tag_keys Sequence[str]: List filter by tag keys.
tag_values Sequence[str]: List filter by tag values.

availabilityZone String: The available zone that the CBS instance locates at.
chargeTypes List<String>: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
dedicatedClusterId String: Exclusive cluster id.
id String
instanceIps List<String>: List filter by attached instance public or private IPs.
instanceNames List<String>: List filter by attached instance name.
portable Boolean: Filter by whether the disk is portable (Boolean true or false).
projectId Number: ID of the project with which the CBS is associated.
resultOutputFile String: Used to save results.
storageId String: ID of the CBS to be queried.
storageName String: Name of the CBS to be queried.
storageStates List<String>: List filter by disk state (UNATTACHED | ATTACHING | ATTACHED | DETACHING | EXPANDING | ROLLBACKING | TORECYCLE).
storageType String: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage String: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tagKeys List<String>: List filter by tag keys.
tagValues List<String>: List filter by tag values.

getCbsStorages Result

The following output properties are available:

Id string
StorageLists List<GetCbsStoragesStorageList>: A list of storage. Each element contains the following attributes:
AvailabilityZone string: The zone of CBS.
ChargeTypes List<string>: Pay type of the CBS instance.
DedicatedClusterId string: Exclusive cluster id.
InstanceIps List<string>
InstanceNames List<string>
Portable bool
ProjectId double: ID of the project.
ResultOutputFile string
StorageId string: ID of CBS.
StorageName string: Name of CBS.
StorageStates List<string>
StorageType string: Types of storage medium.
StorageUsage string: Types of CBS.
TagKeys List<string>
TagValues List<string>

Id string
StorageLists []GetCbsStoragesStorageList: A list of storage. Each element contains the following attributes:
AvailabilityZone string: The zone of CBS.
ChargeTypes []string: Pay type of the CBS instance.
DedicatedClusterId string: Exclusive cluster id.
InstanceIps []string
InstanceNames []string
Portable bool
ProjectId float64: ID of the project.
ResultOutputFile string
StorageId string: ID of CBS.
StorageName string: Name of CBS.
StorageStates []string
StorageType string: Types of storage medium.
StorageUsage string: Types of CBS.
TagKeys []string
TagValues []string

id String
storageLists List<GetCbsStoragesStorageList>: A list of storage. Each element contains the following attributes:
availabilityZone String: The zone of CBS.
chargeTypes List<String>: Pay type of the CBS instance.
dedicatedClusterId String: Exclusive cluster id.
instanceIps List<String>
instanceNames List<String>
portable Boolean
projectId Double: ID of the project.
resultOutputFile String
storageId String: ID of CBS.
storageName String: Name of CBS.
storageStates List<String>
storageType String: Types of storage medium.
storageUsage String: Types of CBS.
tagKeys List<String>
tagValues List<String>

id string
storageLists GetCbsStoragesStorageList[]: A list of storage. Each element contains the following attributes:
availabilityZone string: The zone of CBS.
chargeTypes string[]: Pay type of the CBS instance.
dedicatedClusterId string: Exclusive cluster id.
instanceIps string[]
instanceNames string[]
portable boolean
projectId number: ID of the project.
resultOutputFile string
storageId string: ID of CBS.
storageName string: Name of CBS.
storageStates string[]
storageType string: Types of storage medium.
storageUsage string: Types of CBS.
tagKeys string[]
tagValues string[]

id str
storage_lists Sequence[GetCbsStoragesStorageList]: A list of storage. Each element contains the following attributes:
availability_zone str: The zone of CBS.
charge_types Sequence[str]: Pay type of the CBS instance.
dedicated_cluster_id str: Exclusive cluster id.
instance_ips Sequence[str]
instance_names Sequence[str]
portable bool
project_id float: ID of the project.
result_output_file str
storage_id str: ID of CBS.
storage_name str: Name of CBS.
storage_states Sequence[str]
storage_type str: Types of storage medium.
storage_usage str: Types of CBS.
tag_keys Sequence[str]
tag_values Sequence[str]

id String
storageLists List<Property Map>: A list of storage. Each element contains the following attributes:
availabilityZone String: The zone of CBS.
chargeTypes List<String>: Pay type of the CBS instance.
dedicatedClusterId String: Exclusive cluster id.
instanceIps List<String>
instanceNames List<String>
portable Boolean
projectId Number: ID of the project.
resultOutputFile String
storageId String: ID of CBS.
storageName String: Name of CBS.
storageStates List<String>
storageType String: Types of storage medium.
storageUsage String: Types of CBS.
tagKeys List<String>
tagValues List<String>

Supporting Types

GetCbsStoragesStorageList

Attached bool: Indicates whether the CBS is mounted the CVM.
AvailabilityZone string: The available zone that the CBS instance locates at.
ChargeType string: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
CreateTime string: Creation time of CBS.
DedicatedClusterId string: Exclusive cluster id.
Encrypt bool: Indicates whether CBS is encrypted.
InstanceId string: ID of the CVM instance that be mounted by this CBS.
KmsKeyId string: Kms key ID.
PrepaidRenewFlag string: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
ProjectId double: ID of the project with which the CBS is associated.
Status string: Status of CBS.
StorageId string: ID of the CBS to be queried.
StorageName string: Name of the CBS to be queried.
StorageSize double: Volume of CBS.
StorageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
StorageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
Tags Dictionary<string, string>: The available tags within this CBS.
ThroughputPerformance double: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

Attached bool: Indicates whether the CBS is mounted the CVM.
AvailabilityZone string: The available zone that the CBS instance locates at.
ChargeType string: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
CreateTime string: Creation time of CBS.
DedicatedClusterId string: Exclusive cluster id.
Encrypt bool: Indicates whether CBS is encrypted.
InstanceId string: ID of the CVM instance that be mounted by this CBS.
KmsKeyId string: Kms key ID.
PrepaidRenewFlag string: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
ProjectId float64: ID of the project with which the CBS is associated.
Status string: Status of CBS.
StorageId string: ID of the CBS to be queried.
StorageName string: Name of the CBS to be queried.
StorageSize float64: Volume of CBS.
StorageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
StorageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
Tags map[string]string: The available tags within this CBS.
ThroughputPerformance float64: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

attached Boolean: Indicates whether the CBS is mounted the CVM.
availabilityZone String: The available zone that the CBS instance locates at.
chargeType String: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
createTime String: Creation time of CBS.
dedicatedClusterId String: Exclusive cluster id.
encrypt Boolean: Indicates whether CBS is encrypted.
instanceId String: ID of the CVM instance that be mounted by this CBS.
kmsKeyId String: Kms key ID.
prepaidRenewFlag String: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
projectId Double: ID of the project with which the CBS is associated.
status String: Status of CBS.
storageId String: ID of the CBS to be queried.
storageName String: Name of the CBS to be queried.
storageSize Double: Volume of CBS.
storageType String: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage String: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tags Map<String,String>: The available tags within this CBS.
throughputPerformance Double: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

attached boolean: Indicates whether the CBS is mounted the CVM.
availabilityZone string: The available zone that the CBS instance locates at.
chargeType string: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
createTime string: Creation time of CBS.
dedicatedClusterId string: Exclusive cluster id.
encrypt boolean: Indicates whether CBS is encrypted.
instanceId string: ID of the CVM instance that be mounted by this CBS.
kmsKeyId string: Kms key ID.
prepaidRenewFlag string: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
projectId number: ID of the project with which the CBS is associated.
status string: Status of CBS.
storageId string: ID of the CBS to be queried.
storageName string: Name of the CBS to be queried.
storageSize number: Volume of CBS.
storageType string: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage string: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tags {[key: string]: string}: The available tags within this CBS.
throughputPerformance number: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

attached bool: Indicates whether the CBS is mounted the CVM.
availability_zone str: The available zone that the CBS instance locates at.
charge_type str: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
create_time str: Creation time of CBS.
dedicated_cluster_id str: Exclusive cluster id.
encrypt bool: Indicates whether CBS is encrypted.
instance_id str: ID of the CVM instance that be mounted by this CBS.
kms_key_id str: Kms key ID.
prepaid_renew_flag str: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
project_id float: ID of the project with which the CBS is associated.
status str: Status of CBS.
storage_id str: ID of the CBS to be queried.
storage_name str: Name of the CBS to be queried.
storage_size float: Volume of CBS.
storage_type str: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storage_usage str: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tags Mapping[str, str]: The available tags within this CBS.
throughput_performance float: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

attached Boolean: Indicates whether the CBS is mounted the CVM.
availabilityZone String: The available zone that the CBS instance locates at.
chargeType String: List filter by disk charge type (POSTPAID_BY_HOUR | PREPAID | CDCPAID | DEDICATED_CLUSTER_PAID).
createTime String: Creation time of CBS.
dedicatedClusterId String: Exclusive cluster id.
encrypt Boolean: Indicates whether CBS is encrypted.
instanceId String: ID of the CVM instance that be mounted by this CBS.
kmsKeyId String: Kms key ID.
prepaidRenewFlag String: The way that CBS instance will be renew automatically or not when it reach the end of the prepaid tenancy.
projectId Number: ID of the project with which the CBS is associated.
status String: Status of CBS.
storageId String: ID of the CBS to be queried.
storageName String: Name of the CBS to be queried.
storageSize Number: Volume of CBS.
storageType String: Filter by cloud disk media type (CLOUD_BASIC: HDD cloud disk | CLOUD_PREMIUM: Premium Cloud Storage | CLOUD_SSD: SSD cloud disk).
storageUsage String: Filter by cloud disk type (SYSTEM_DISK: system disk | DATA_DISK: data disk).
tags Map<String>: The available tags within this CBS.
throughputPerformance Number: Add extra performance to the data disk. Only works when disk type is CLOUD_TSSD or CLOUD_HSSD.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getCbsStorages

On this page

On this page

Example Usage

Query all CBS storages

Query CBS by storage id

Query CBS by dedicated cluster id

The following snippet shows the new supported query params

Using getCbsStorages

getCbsStorages Result

Supporting Types

GetCbsStoragesStorageList

Package Details

On this page

On this page