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

volcenginecc.storageebs.getVolume

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

    Data Source schema for Volcengine::StorageEBS::Volume

    Using getVolume

    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 getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
    function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>
    def get_volume(id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetVolumeResult
    def get_volume_output(id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
    func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
    func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

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

    public static class GetVolume 
    {
        public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
        public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
    public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:storageebs/getVolume:getVolume
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getVolume Result

    The following output properties are available:

    AutoSnapshotPolicyId string
    自动快照策略ID。
    AutoSnapshotPolicyName string
    自动快照策略名称。
    BaselinePerformance Volcengine.GetVolumeBaselinePerformance
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    ExtraPerformance Volcengine.GetVolumeExtraPerformance
    额外性能。
    Id string
    Uniquely identifies the resource.
    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.GetVolumeTotalPerformance
    总性能。
    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 GetVolumeBaselinePerformance
    基本性能。
    CreatedAt string
    云盘创建时间。
    DeleteWithInstance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    Description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    DeviceName string
    设备名称
    ErrorDetail string
    具体错误
    ExpiredTime string
    包年包月到期时间。
    ExtraPerformance GetVolumeExtraPerformance
    额外性能。
    Id string
    Uniquely identifies the resource.
    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 GetVolumeTotalPerformance
    总性能。
    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 GetVolumeBaselinePerformance
    基本性能。
    createdAt String
    云盘创建时间。
    deleteWithInstance Boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description String
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    deviceName String
    设备名称
    errorDetail String
    具体错误
    expiredTime String
    包年包月到期时间。
    extraPerformance GetVolumeExtraPerformance
    额外性能。
    id String
    Uniquely identifies the resource.
    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 GetVolumeTotalPerformance
    总性能。
    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 GetVolumeBaselinePerformance
    基本性能。
    createdAt string
    云盘创建时间。
    deleteWithInstance boolean
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description string
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    deviceName string
    设备名称
    errorDetail string
    具体错误
    expiredTime string
    包年包月到期时间。
    extraPerformance GetVolumeExtraPerformance
    额外性能。
    id string
    Uniquely identifies the resource.
    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 GetVolumeTotalPerformance
    总性能。
    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 GetVolumeBaselinePerformance
    基本性能。
    created_at str
    云盘创建时间。
    delete_with_instance bool
    释放实例时,该云盘是否随实例一起释放,取值说明如下:true:云盘随实例一起释放。false:云盘不随实例一起释放。
    description str
    云盘的描述信息,默认为空,长度限制在1 ~ 255字符之间。
    device_name str
    设备名称
    error_detail str
    具体错误
    expired_time str
    包年包月到期时间。
    extra_performance GetVolumeExtraPerformance
    额外性能。
    id str
    Uniquely identifies the resource.
    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 GetVolumeTotalPerformance
    总性能。
    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
    额外性能。
    id String
    Uniquely identifies the resource.
    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

    GetVolumeBaselinePerformance

    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
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。

    GetVolumeExtraPerformance

    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
    云盘的额外吞吐量。

    GetVolumeTotalPerformance

    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
    云盘的总吞吐量,即云盘的基准吞吐量和额外吞吐量之和。

    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