1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. storageebs
  5. Volume
volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcenginecc.storageebs.Volume

Deploy with Pulumi
volcenginecc logo
volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

    云盘是高可用、高可靠、高性能、弹性扩展的块存储设备,可以作为云服务器和弹性容器服务的可扩展硬盘使用。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const volumeDemo = new volcenginecc.storageebs.Volume("VolumeDemo", {
        volumeName: "EBS-VolumeDemo",
        volumeType: "ESSD_PL0",
        size: 10,
        zoneId: "cn-beijing-x",
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    volume_demo = volcenginecc.storageebs.Volume("VolumeDemo",
        volume_name="EBS-VolumeDemo",
        volume_type="ESSD_PL0",
        size=10,
        zone_id="cn-beijing-x")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/storageebs"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := storageebs.NewVolume(ctx, "VolumeDemo", &storageebs.VolumeArgs{
    			VolumeName: pulumi.String("EBS-VolumeDemo"),
    			VolumeType: pulumi.String("ESSD_PL0"),
    			Size:       pulumi.Float64(10),
    			ZoneId:     pulumi.String("cn-beijing-x"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var volumeDemo = new Volcenginecc.Storageebs.Volume("VolumeDemo", new()
        {
            VolumeName = "EBS-VolumeDemo",
            VolumeType = "ESSD_PL0",
            Size = 10,
            ZoneId = "cn-beijing-x",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.storageebs.Volume;
    import com.volcengine.volcenginecc.storageebs.VolumeArgs;
    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) {
            var volumeDemo = new Volume("volumeDemo", VolumeArgs.builder()
                .volumeName("EBS-VolumeDemo")
                .volumeType("ESSD_PL0")
                .size(10.0)
                .zoneId("cn-beijing-x")
                .build());
    
        }
    }
    
    resources:
      volumeDemo:
        type: volcenginecc:storageebs:Volume
        name: VolumeDemo
        properties:
          volumeName: EBS-VolumeDemo
          volumeType: ESSD_PL0
          size: 10
          zoneId: cn-beijing-x
    

    Create Volume Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
    @overload
    def Volume(resource_name: str,
               args: VolumeArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Volume(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               size: Optional[float] = None,
               zone_id: Optional[str] = None,
               volume_type: Optional[str] = None,
               volume_name: Optional[str] = None,
               pay_type: Optional[str] = None,
               kind: Optional[str] = None,
               auto_snapshot_policy_id: Optional[str] = None,
               project_name: Optional[str] = None,
               instance_id: Optional[str] = None,
               source_snapshot_id: Optional[str] = None,
               extra_performance: Optional[VolumeExtraPerformanceArgs] = None,
               description: Optional[str] = None,
               delete_with_instance: Optional[bool] = None)
    func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
    public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
    public Volume(String name, VolumeArgs args)
    public Volume(String name, VolumeArgs args, CustomResourceOptions options)
    
    type: volcenginecc:storageebs:Volume
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var volumeResource = new Volcenginecc.Storageebs.Volume("volumeResource", new()
    {
        Size = 0,
        ZoneId = "string",
        VolumeType = "string",
        VolumeName = "string",
        PayType = "string",
        Kind = "string",
        AutoSnapshotPolicyId = "string",
        ProjectName = "string",
        InstanceId = "string",
        SourceSnapshotId = "string",
        ExtraPerformance = new Volcenginecc.Storageebs.Inputs.VolumeExtraPerformanceArgs
        {
            ExtraPerformanceTypeId = "string",
            Iops = 0,
            Throughput = 0,
        },
        Description = "string",
        DeleteWithInstance = false,
    });
    
    example, err := storageebs.NewVolume(ctx, "volumeResource", &storageebs.VolumeArgs{
    	Size:                 pulumi.Float64(0),
    	ZoneId:               pulumi.String("string"),
    	VolumeType:           pulumi.String("string"),
    	VolumeName:           pulumi.String("string"),
    	PayType:              pulumi.String("string"),
    	Kind:                 pulumi.String("string"),
    	AutoSnapshotPolicyId: pulumi.String("string"),
    	ProjectName:          pulumi.String("string"),
    	InstanceId:           pulumi.String("string"),
    	SourceSnapshotId:     pulumi.String("string"),
    	ExtraPerformance: &storageebs.VolumeExtraPerformanceArgs{
    		ExtraPerformanceTypeId: pulumi.String("string"),
    		Iops:                   pulumi.Float64(0),
    		Throughput:             pulumi.Float64(0),
    	},
    	Description:        pulumi.String("string"),
    	DeleteWithInstance: pulumi.Bool(false),
    })
    
    var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
        .size(0.0)
        .zoneId("string")
        .volumeType("string")
        .volumeName("string")
        .payType("string")
        .kind("string")
        .autoSnapshotPolicyId("string")
        .projectName("string")
        .instanceId("string")
        .sourceSnapshotId("string")
        .extraPerformance(VolumeExtraPerformanceArgs.builder()
            .extraPerformanceTypeId("string")
            .iops(0.0)
            .throughput(0.0)
            .build())
        .description("string")
        .deleteWithInstance(false)
        .build());
    
    volume_resource = volcenginecc.storageebs.Volume("volumeResource",
        size=0,
        zone_id="string",
        volume_type="string",
        volume_name="string",
        pay_type="string",
        kind="string",
        auto_snapshot_policy_id="string",
        project_name="string",
        instance_id="string",
        source_snapshot_id="string",
        extra_performance={
            "extra_performance_type_id": "string",
            "iops": 0,
            "throughput": 0,
        },
        description="string",
        delete_with_instance=False)
    
    const volumeResource = new volcenginecc.storageebs.Volume("volumeResource", {
        size: 0,
        zoneId: "string",
        volumeType: "string",
        volumeName: "string",
        payType: "string",
        kind: "string",
        autoSnapshotPolicyId: "string",
        projectName: "string",
        instanceId: "string",
        sourceSnapshotId: "string",
        extraPerformance: {
            extraPerformanceTypeId: "string",
            iops: 0,
            throughput: 0,
        },
        description: "string",
        deleteWithInstance: false,
    });
    
    type: volcenginecc:storageebs:Volume
    properties:
        autoSnapshotPolicyId: string
        deleteWithInstance: false
        description: string
        extraPerformance:
            extraPerformanceTypeId: string
            iops: 0
            throughput: 0
        instanceId: string
        kind: string
        payType: string
        projectName: string
        size: 0
        sourceSnapshotId: string
        volumeName: string
        volumeType: string
        zoneId: string
    

    Volume Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Volume resource accepts the following input properties:

    Size double
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    VolumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    VolumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    ZoneId string
    可用区ID。
    AutoSnapshotPolicyId string
    自动快照策略ID。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    ExtraPerformance Volcengine.VolumeExtraPerformance
    额外性能。
    InstanceId string
    创建云盘的同时挂载的ECS实例ID。
    Kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    PayType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    ProjectName string
    云盘所要加入的Project(项目)名称。
    SourceSnapshotId string
    源快照。
    Size float64
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    VolumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    VolumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    ZoneId string
    可用区ID。
    AutoSnapshotPolicyId string
    自动快照策略ID。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    ExtraPerformance VolumeExtraPerformanceArgs
    额外性能。
    InstanceId string
    创建云盘的同时挂载的ECS实例ID。
    Kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    PayType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    ProjectName string
    云盘所要加入的Project(项目)名称。
    SourceSnapshotId string
    源快照。
    size Double
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    volumeName String
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType String
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId String
    可用区ID。
    autoSnapshotPolicyId String
    自动快照策略ID。
    deleteWithInstance Boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description String
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    extraPerformance VolumeExtraPerformance
    额外性能。
    instanceId String
    创建云盘的同时挂载的ECS实例ID。
    kind String
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    payType String
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName String
    云盘所要加入的Project(项目)名称。
    sourceSnapshotId String
    源快照。
    size number
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    volumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId string
    可用区ID。
    autoSnapshotPolicyId string
    自动快照策略ID。
    deleteWithInstance boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    extraPerformance VolumeExtraPerformance
    额外性能。
    instanceId string
    创建云盘的同时挂载的ECS实例ID。
    kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    payType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName string
    云盘所要加入的Project(项目)名称。
    sourceSnapshotId string
    源快照。
    size float
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    volume_name str
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volume_type str
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zone_id str
    可用区ID。
    auto_snapshot_policy_id str
    自动快照策略ID。
    delete_with_instance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description str
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    extra_performance VolumeExtraPerformanceArgs
    额外性能。
    instance_id str
    创建云盘的同时挂载的ECS实例ID。
    kind str
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    pay_type str
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    project_name str
    云盘所要加入的Project(项目)名称。
    source_snapshot_id str
    源快照。
    size Number
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    volumeName String
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType String
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId String
    可用区ID。
    autoSnapshotPolicyId String
    自动快照策略ID。
    deleteWithInstance Boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description String
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    extraPerformance Property Map
    额外性能。
    instanceId String
    创建云盘的同时挂载的ECS实例ID。
    kind String
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    payType String
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName String
    云盘所要加入的Project(项目)名称。
    sourceSnapshotId String
    源快照。

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

    AutoSnapshotPolicyName string
    自动快照策略名称。
    BaselinePerformance Volcengine.VolumeBaselinePerformance
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    云盘中的镜像ID。
    OverdueReclaimTime string
    云盘欠费回收时间。
    OverdueTime string
    云盘欠费关停时间。
    RenewType double
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    SnapshotCount double
    快照计数
    Status string
    云盘状态
    TotalPerformance Volcengine.VolumeTotalPerformance
    总性能。
    TradeStatus double
    交易状态 0:创建中 1:运行中 2:创建失败
    UpdatedAt string
    云盘更新时间。
    VolumeId string
    云盘id。
    AutoSnapshotPolicyName string
    自动快照策略名称。
    BaselinePerformance VolumeBaselinePerformance
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    云盘中的镜像ID。
    OverdueReclaimTime string
    云盘欠费回收时间。
    OverdueTime string
    云盘欠费关停时间。
    RenewType float64
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    SnapshotCount float64
    快照计数
    Status string
    云盘状态
    TotalPerformance VolumeTotalPerformance
    总性能。
    TradeStatus float64
    交易状态 0:创建中 1:运行中 2:创建失败
    UpdatedAt string
    云盘更新时间。
    VolumeId string
    云盘id。
    autoSnapshotPolicyName String
    自动快照策略名称。
    baselinePerformance VolumeBaselinePerformance
    基本性能。
    createdAt String
    云盘创建时间。
    deviceName String
    设备名称
    errorDetail String
    具体错误
    expiredTime String
    包年包月到期时间。
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    云盘中的镜像ID。
    overdueReclaimTime String
    云盘欠费回收时间。
    overdueTime String
    云盘欠费关停时间。
    renewType Double
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    snapshotCount Double
    快照计数
    status String
    云盘状态
    totalPerformance VolumeTotalPerformance
    总性能。
    tradeStatus Double
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt String
    云盘更新时间。
    volumeId String
    云盘id。
    autoSnapshotPolicyName string
    自动快照策略名称。
    baselinePerformance VolumeBaselinePerformance
    基本性能。
    createdAt string
    云盘创建时间。
    deviceName string
    设备名称
    errorDetail string
    具体错误
    expiredTime string
    包年包月到期时间。
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    云盘中的镜像ID。
    overdueReclaimTime string
    云盘欠费回收时间。
    overdueTime string
    云盘欠费关停时间。
    renewType number
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    snapshotCount number
    快照计数
    status string
    云盘状态
    totalPerformance VolumeTotalPerformance
    总性能。
    tradeStatus number
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt string
    云盘更新时间。
    volumeId string
    云盘id。
    auto_snapshot_policy_name str
    自动快照策略名称。
    baseline_performance VolumeBaselinePerformance
    基本性能。
    created_at str
    云盘创建时间。
    device_name str
    设备名称
    error_detail str
    具体错误
    expired_time str
    包年包月到期时间。
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    云盘中的镜像ID。
    overdue_reclaim_time str
    云盘欠费回收时间。
    overdue_time str
    云盘欠费关停时间。
    renew_type float
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    snapshot_count float
    快照计数
    status str
    云盘状态
    total_performance VolumeTotalPerformance
    总性能。
    trade_status float
    交易状态 0:创建中 1:运行中 2:创建失败
    updated_at str
    云盘更新时间。
    volume_id str
    云盘id。
    autoSnapshotPolicyName String
    自动快照策略名称。
    baselinePerformance Property Map
    基本性能。
    createdAt String
    云盘创建时间。
    deviceName String
    设备名称
    errorDetail String
    具体错误
    expiredTime String
    包年包月到期时间。
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    云盘中的镜像ID。
    overdueReclaimTime String
    云盘欠费回收时间。
    overdueTime String
    云盘欠费关停时间。
    renewType Number
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    snapshotCount Number
    快照计数
    status String
    云盘状态
    totalPerformance Property Map
    总性能。
    tradeStatus Number
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt String
    云盘更新时间。
    volumeId String
    云盘id。

    Look up Existing Volume Resource

    Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_snapshot_policy_id: Optional[str] = None,
            auto_snapshot_policy_name: Optional[str] = None,
            baseline_performance: Optional[VolumeBaselinePerformanceArgs] = None,
            created_at: Optional[str] = None,
            delete_with_instance: Optional[bool] = None,
            description: Optional[str] = None,
            device_name: Optional[str] = None,
            error_detail: Optional[str] = None,
            expired_time: Optional[str] = None,
            extra_performance: Optional[VolumeExtraPerformanceArgs] = None,
            image_id: Optional[str] = None,
            instance_id: Optional[str] = None,
            kind: Optional[str] = None,
            overdue_reclaim_time: Optional[str] = None,
            overdue_time: Optional[str] = None,
            pay_type: Optional[str] = None,
            project_name: Optional[str] = None,
            renew_type: Optional[float] = None,
            size: Optional[float] = None,
            snapshot_count: Optional[float] = None,
            source_snapshot_id: Optional[str] = None,
            status: Optional[str] = None,
            total_performance: Optional[VolumeTotalPerformanceArgs] = None,
            trade_status: Optional[float] = None,
            updated_at: Optional[str] = None,
            volume_id: Optional[str] = None,
            volume_name: Optional[str] = None,
            volume_type: Optional[str] = None,
            zone_id: Optional[str] = None) -> Volume
    func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
    public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
    public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:storageebs:Volume    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoSnapshotPolicyId string
    自动快照策略ID。
    AutoSnapshotPolicyName string
    自动快照策略名称。
    BaselinePerformance Volcengine.VolumeBaselinePerformance
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    ExtraPerformance Volcengine.VolumeExtraPerformance
    额外性能。
    ImageId string
    云盘中的镜像ID。
    InstanceId string
    创建云盘的同时挂载的ECS实例ID。
    Kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    OverdueReclaimTime string
    云盘欠费回收时间。
    OverdueTime string
    云盘欠费关停时间。
    PayType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    ProjectName string
    云盘所要加入的Project(项目)名称。
    RenewType double
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    Size double
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    SnapshotCount double
    快照计数
    SourceSnapshotId string
    源快照。
    Status string
    云盘状态
    TotalPerformance Volcengine.VolumeTotalPerformance
    总性能。
    TradeStatus double
    交易状态 0:创建中 1:运行中 2:创建失败
    UpdatedAt string
    云盘更新时间。
    VolumeId string
    云盘id。
    VolumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    VolumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    ZoneId string
    可用区ID。
    AutoSnapshotPolicyId string
    自动快照策略ID。
    AutoSnapshotPolicyName string
    自动快照策略名称。
    BaselinePerformance VolumeBaselinePerformanceArgs
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    ExtraPerformance VolumeExtraPerformanceArgs
    额外性能。
    ImageId string
    云盘中的镜像ID。
    InstanceId string
    创建云盘的同时挂载的ECS实例ID。
    Kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    OverdueReclaimTime string
    云盘欠费回收时间。
    OverdueTime string
    云盘欠费关停时间。
    PayType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    ProjectName string
    云盘所要加入的Project(项目)名称。
    RenewType float64
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    Size float64
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    SnapshotCount float64
    快照计数
    SourceSnapshotId string
    源快照。
    Status string
    云盘状态
    TotalPerformance VolumeTotalPerformanceArgs
    总性能。
    TradeStatus float64
    交易状态 0:创建中 1:运行中 2:创建失败
    UpdatedAt string
    云盘更新时间。
    VolumeId string
    云盘id。
    VolumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    VolumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    ZoneId string
    可用区ID。
    autoSnapshotPolicyId String
    自动快照策略ID。
    autoSnapshotPolicyName String
    自动快照策略名称。
    baselinePerformance VolumeBaselinePerformance
    基本性能。
    createdAt String
    云盘创建时间。
    deleteWithInstance Boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description String
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    deviceName String
    设备名称
    errorDetail String
    具体错误
    expiredTime String
    包年包月到期时间。
    extraPerformance VolumeExtraPerformance
    额外性能。
    imageId String
    云盘中的镜像ID。
    instanceId String
    创建云盘的同时挂载的ECS实例ID。
    kind String
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    overdueReclaimTime String
    云盘欠费回收时间。
    overdueTime String
    云盘欠费关停时间。
    payType String
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName String
    云盘所要加入的Project(项目)名称。
    renewType Double
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    size Double
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    snapshotCount Double
    快照计数
    sourceSnapshotId String
    源快照。
    status String
    云盘状态
    totalPerformance VolumeTotalPerformance
    总性能。
    tradeStatus Double
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt String
    云盘更新时间。
    volumeId String
    云盘id。
    volumeName String
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType String
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId String
    可用区ID。
    autoSnapshotPolicyId string
    自动快照策略ID。
    autoSnapshotPolicyName string
    自动快照策略名称。
    baselinePerformance VolumeBaselinePerformance
    基本性能。
    createdAt string
    云盘创建时间。
    deleteWithInstance boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    deviceName string
    设备名称
    errorDetail string
    具体错误
    expiredTime string
    包年包月到期时间。
    extraPerformance VolumeExtraPerformance
    额外性能。
    imageId string
    云盘中的镜像ID。
    instanceId string
    创建云盘的同时挂载的ECS实例ID。
    kind string
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    overdueReclaimTime string
    云盘欠费回收时间。
    overdueTime string
    云盘欠费关停时间。
    payType string
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName string
    云盘所要加入的Project(项目)名称。
    renewType number
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    size number
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    snapshotCount number
    快照计数
    sourceSnapshotId string
    源快照。
    status string
    云盘状态
    totalPerformance VolumeTotalPerformance
    总性能。
    tradeStatus number
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt string
    云盘更新时间。
    volumeId string
    云盘id。
    volumeName string
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType string
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId string
    可用区ID。
    auto_snapshot_policy_id str
    自动快照策略ID。
    auto_snapshot_policy_name str
    自动快照策略名称。
    baseline_performance VolumeBaselinePerformanceArgs
    基本性能。
    created_at str
    云盘创建时间。
    delete_with_instance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description str
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    device_name str
    设备名称
    error_detail str
    具体错误
    expired_time str
    包年包月到期时间。
    extra_performance VolumeExtraPerformanceArgs
    额外性能。
    image_id str
    云盘中的镜像ID。
    instance_id str
    创建云盘的同时挂载的ECS实例ID。
    kind str
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    overdue_reclaim_time str
    云盘欠费回收时间。
    overdue_time str
    云盘欠费关停时间。
    pay_type str
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    project_name str
    云盘所要加入的Project(项目)名称。
    renew_type float
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    size float
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    snapshot_count float
    快照计数
    source_snapshot_id str
    源快照。
    status str
    云盘状态
    total_performance VolumeTotalPerformanceArgs
    总性能。
    trade_status float
    交易状态 0:创建中 1:运行中 2:创建失败
    updated_at str
    云盘更新时间。
    volume_id str
    云盘id。
    volume_name str
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volume_type str
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zone_id str
    可用区ID。
    autoSnapshotPolicyId String
    自动快照策略ID。
    autoSnapshotPolicyName String
    自动快照策略名称。
    baselinePerformance Property Map
    基本性能。
    createdAt String
    云盘创建时间。
    deleteWithInstance Boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description String
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    deviceName String
    设备名称
    errorDetail String
    具体错误
    expiredTime String
    包年包月到期时间。
    extraPerformance Property Map
    额外性能。
    imageId String
    云盘中的镜像ID。
    instanceId String
    创建云盘的同时挂载的ECS实例ID。
    kind String
    云盘属性,data表示数据盘。默认值为data。说明: 仅支持创建数据盘。
    overdueReclaimTime String
    云盘欠费回收时间。
    overdueTime String
    云盘欠费关停时间。
    payType String
    付费类型,说明如下: Pre:预付费(包年包月) Post:后付费(按量计费)。
    projectName String
    云盘所要加入的Project(项目)名称。
    renewType Number
    续费方式 1:手动续费 2 :自动续费 3 :到期不续费。
    size Number
    Size,数据盘容量大小,单位为GiB。不同类型的数据盘容量范围如下:ESSDPL0:10~65536 GiB;ESSDFlexPL:10~65536 GiB;TSSD_TL0:40~65536 GiB
    snapshotCount Number
    快照计数
    sourceSnapshotId String
    源快照。
    status String
    云盘状态
    totalPerformance Property Map
    总性能。
    tradeStatus Number
    交易状态 0:创建中 1:运行中 2:创建失败
    updatedAt String
    云盘更新时间。
    volumeId String
    云盘id。
    volumeName String
    云盘显示名称。命名规则如下:首字符仅支持中文、字母或下划线()。可包含中文、字母、数字、下划线()或中划线(-)。长度限制在1~128字符之间。
    volumeType String
    云盘类型,取值说明如下:ESSDPL0:极速型SSD云盘,PL0规格。ESSDFlexPL: 极速型SSD云盘,FlexPL规格。TSSD_TL0: 吞吐型SSD云盘。
    zoneId String
    可用区ID。

    Supporting Types

    VolumeBaselinePerformance, VolumeBaselinePerformanceArgs

    Iops double
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    Throughput double
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    Iops float64
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    Throughput float64
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops Double
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput Double
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops number
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput number
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops float
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput float
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops Number
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput Number
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。

    VolumeExtraPerformance, VolumeExtraPerformanceArgs

    ExtraPerformanceTypeId string
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    Iops double
    云盘的额外IOPS。
    Throughput double
    云盘的额外吞吐量。
    ExtraPerformanceTypeId string
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    Iops float64
    云盘的额外IOPS。
    Throughput float64
    云盘的额外吞吐量。
    extraPerformanceTypeId String
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    iops Double
    云盘的额外IOPS。
    throughput Double
    云盘的额外吞吐量。
    extraPerformanceTypeId string
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    iops number
    云盘的额外IOPS。
    throughput number
    云盘的额外吞吐量。
    extra_performance_type_id str
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    iops float
    云盘的额外IOPS。
    throughput float
    云盘的额外吞吐量。
    extraPerformanceTypeId String
    额外性能的类型,取值如下:Balance:均衡型额外性能;IOPS:IOPS型额外性能;Throughput:吞吐量型额外性能。
    iops Number
    云盘的额外IOPS。
    throughput Number
    云盘的额外吞吐量。

    VolumeTotalPerformance, VolumeTotalPerformanceArgs

    Iops double
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    Throughput double
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    Iops float64
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    Throughput float64
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops Double
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput Double
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops number
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput number
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops float
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput float
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。
    iops Number
    云盘的总IOPS,即云盘的基准IOPS和额外IOPS之和。
    throughput Number
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。

    Import

    $ pulumi import volcenginecc:storageebs/volume:Volume example "volume_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine
      Meet Neo: Your AI Platform Teammate