volcenginecc.storageebs.getVolume

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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: Automatic snapshot policy ID.
AutoSnapshotPolicyName string: Automatic snapshot policy name.
BaselinePerformance Volcengine.GetVolumeBaselinePerformance: Baseline performance.
CreatedAt string: Disk creation time.
DeleteWithInstance bool: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
Description string: Disk description. Default is empty. Length must be between 1 and 255 characters.
DeviceName string: Device name
ErrorDetail string: Specific error
ExpiredTime string: Expiration time for yearly/monthly subscription.
ExtraPerformance Volcengine.GetVolumeExtraPerformance: Extra performance.
Id string: Uniquely identifies the resource.
ImageId string: Image ID in the disk.
InstanceId string: ECS instance ID mounted when creating the cloud disk.
Kind string: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
OverdueReclaimTime string: Disk overdue reclamation time.
OverdueTime string: Disk overdue shutdown time.
PayType string: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
ProjectName string: Project name to which the disk will be added.
RenewType double: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
Size double: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
SnapshotCount double: Snapshot count.
SourceSnapshotId string: Source snapshot.
Status string: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
Tags List<Volcengine.GetVolumeTag>: Disk tag information.
TotalPerformance Volcengine.GetVolumeTotalPerformance: Total performance.
TradeStatus double: Transaction status 0: Creating 1: Running 2: Creation failed
UpdatedAt string: Disk update time.
VolumeId string: Disk ID.
VolumeName string: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
VolumeType string: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
ZoneId string: Availability zone ID.

AutoSnapshotPolicyId string: Automatic snapshot policy ID.
AutoSnapshotPolicyName string: Automatic snapshot policy name.
BaselinePerformance GetVolumeBaselinePerformance: Baseline performance.
CreatedAt string: Disk creation time.
DeleteWithInstance bool: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
Description string: Disk description. Default is empty. Length must be between 1 and 255 characters.
DeviceName string: Device name
ErrorDetail string: Specific error
ExpiredTime string: Expiration time for yearly/monthly subscription.
ExtraPerformance GetVolumeExtraPerformance: Extra performance.
Id string: Uniquely identifies the resource.
ImageId string: Image ID in the disk.
InstanceId string: ECS instance ID mounted when creating the cloud disk.
Kind string: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
OverdueReclaimTime string: Disk overdue reclamation time.
OverdueTime string: Disk overdue shutdown time.
PayType string: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
ProjectName string: Project name to which the disk will be added.
RenewType float64: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
Size float64: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
SnapshotCount float64: Snapshot count.
SourceSnapshotId string: Source snapshot.
Status string: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
Tags []GetVolumeTag: Disk tag information.
TotalPerformance GetVolumeTotalPerformance: Total performance.
TradeStatus float64: Transaction status 0: Creating 1: Running 2: Creation failed
UpdatedAt string: Disk update time.
VolumeId string: Disk ID.
VolumeName string: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
VolumeType string: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
ZoneId string: Availability zone ID.

autoSnapshotPolicyId String: Automatic snapshot policy ID.
autoSnapshotPolicyName String: Automatic snapshot policy name.
baselinePerformance GetVolumeBaselinePerformance: Baseline performance.
createdAt String: Disk creation time.
deleteWithInstance Boolean: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
description String: Disk description. Default is empty. Length must be between 1 and 255 characters.
deviceName String: Device name
errorDetail String: Specific error
expiredTime String: Expiration time for yearly/monthly subscription.
extraPerformance GetVolumeExtraPerformance: Extra performance.
id String: Uniquely identifies the resource.
imageId String: Image ID in the disk.
instanceId String: ECS instance ID mounted when creating the cloud disk.
kind String: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
overdueReclaimTime String: Disk overdue reclamation time.
overdueTime String: Disk overdue shutdown time.
payType String: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
projectName String: Project name to which the disk will be added.
renewType Double: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
size Double: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
snapshotCount Double: Snapshot count.
sourceSnapshotId String: Source snapshot.
status String: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
tags List<GetVolumeTag>: Disk tag information.
totalPerformance GetVolumeTotalPerformance: Total performance.
tradeStatus Double: Transaction status 0: Creating 1: Running 2: Creation failed
updatedAt String: Disk update time.
volumeId String: Disk ID.
volumeName String: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
volumeType String: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
zoneId String: Availability zone ID.

autoSnapshotPolicyId string: Automatic snapshot policy ID.
autoSnapshotPolicyName string: Automatic snapshot policy name.
baselinePerformance GetVolumeBaselinePerformance: Baseline performance.
createdAt string: Disk creation time.
deleteWithInstance boolean: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
description string: Disk description. Default is empty. Length must be between 1 and 255 characters.
deviceName string: Device name
errorDetail string: Specific error
expiredTime string: Expiration time for yearly/monthly subscription.
extraPerformance GetVolumeExtraPerformance: Extra performance.
id string: Uniquely identifies the resource.
imageId string: Image ID in the disk.
instanceId string: ECS instance ID mounted when creating the cloud disk.
kind string: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
overdueReclaimTime string: Disk overdue reclamation time.
overdueTime string: Disk overdue shutdown time.
payType string: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
projectName string: Project name to which the disk will be added.
renewType number: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
size number: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
snapshotCount number: Snapshot count.
sourceSnapshotId string: Source snapshot.
status string: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
tags GetVolumeTag[]: Disk tag information.
totalPerformance GetVolumeTotalPerformance: Total performance.
tradeStatus number: Transaction status 0: Creating 1: Running 2: Creation failed
updatedAt string: Disk update time.
volumeId string: Disk ID.
volumeName string: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
volumeType string: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
zoneId string: Availability zone ID.

auto_snapshot_policy_id str: Automatic snapshot policy ID.
auto_snapshot_policy_name str: Automatic snapshot policy name.
baseline_performance GetVolumeBaselinePerformance: Baseline performance.
created_at str: Disk creation time.
delete_with_instance bool: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
description str: Disk description. Default is empty. Length must be between 1 and 255 characters.
device_name str: Device name
error_detail str: Specific error
expired_time str: Expiration time for yearly/monthly subscription.
extra_performance GetVolumeExtraPerformance: Extra performance.
id str: Uniquely identifies the resource.
image_id str: Image ID in the disk.
instance_id str: ECS instance ID mounted when creating the cloud disk.
kind str: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
overdue_reclaim_time str: Disk overdue reclamation time.
overdue_time str: Disk overdue shutdown time.
pay_type str: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
project_name str: Project name to which the disk will be added.
renew_type float: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
size float: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
snapshot_count float: Snapshot count.
source_snapshot_id str: Source snapshot.
status str: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
tags Sequence[GetVolumeTag]: Disk tag information.
total_performance GetVolumeTotalPerformance: Total performance.
trade_status float: Transaction status 0: Creating 1: Running 2: Creation failed
updated_at str: Disk update time.
volume_id str: Disk ID.
volume_name str: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
volume_type str: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
zone_id str: Availability zone ID.

autoSnapshotPolicyId String: Automatic snapshot policy ID.
autoSnapshotPolicyName String: Automatic snapshot policy name.
baselinePerformance Property Map: Baseline performance.
createdAt String: Disk creation time.
deleteWithInstance Boolean: When releasing the instance, specify whether the disk is released along with the instance. Value description: true: The disk is released with the instance. false: The disk is not released with the instance.
description String: Disk description. Default is empty. Length must be between 1 and 255 characters.
deviceName String: Device name
errorDetail String: Specific error
expiredTime String: Expiration time for yearly/monthly subscription.
extraPerformance Property Map: Extra performance.
id String: Uniquely identifies the resource.
imageId String: Image ID in the disk.
instanceId String: ECS instance ID mounted when creating the cloud disk.
kind String: Disk attribute. data indicates a data disk. The default value is data. Note: Only data disks can be created.
overdueReclaimTime String: Disk overdue reclamation time.
overdueTime String: Disk overdue shutdown time.
payType String: Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
projectName String: Project name to which the disk will be added.
renewType Number: Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
size Number: Size: data disk capacity in GiB. The capacity ranges for different types of data disks are as follows: ESSDPL0: 10~65536 GiB; ESSDFlexPL: 10~65536 GiB; TSSD_TL0: 40~65536 GiB
snapshotCount Number: Snapshot count.
sourceSnapshotId String: Source snapshot.
status String: Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
tags List<Property Map>: Disk tag information.
totalPerformance Property Map: Total performance.
tradeStatus Number: Transaction status 0: Creating 1: Running 2: Creation failed
updatedAt String: Disk update time.
volumeId String: Disk ID.
volumeName String: Disk display name. Naming rules: The first character must be a Chinese character, a letter, or an underscore (). Can contain Chinese characters, letters, numbers, underscores (), or hyphens (-). Length must be between 1 and 128 characters.
volumeType String: Disk type. Value description: ESSDPL0: Ultra-fast SSD disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD disk, FlexPL specification. TSSD_TL0: Throughput SSD disk.
zoneId String: Availability zone ID.

Supporting Types

GetVolumeBaselinePerformance

Iops double: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
Throughput double: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

Iops float64: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
Throughput float64: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops Double: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput Double: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops number: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput number: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops float: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput float: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops Number: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput Number: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

GetVolumeExtraPerformance

ExtraPerformanceTypeId string: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
Iops double: Extra IOPS of the disk.
Throughput double: Extra throughput of the disk.

ExtraPerformanceTypeId string: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
Iops float64: Extra IOPS of the disk.
Throughput float64: Extra throughput of the disk.

extraPerformanceTypeId String: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
iops Double: Extra IOPS of the disk.
throughput Double: Extra throughput of the disk.

extraPerformanceTypeId string: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
iops number: Extra IOPS of the disk.
throughput number: Extra throughput of the disk.

extra_performance_type_id str: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
iops float: Extra IOPS of the disk.
throughput float: Extra throughput of the disk.

extraPerformanceTypeId String: Type of extra performance. Value description: Balance: Balanced extra performance; IOPS: IOPS extra performance; Throughput: Throughput extra performance.
iops Number: Extra IOPS of the disk.
throughput Number: Extra throughput of the disk.

GetVolumeTag

Key string: Tag key.
Value string: Tag value.

Key string: Tag key.
Value string: Tag value.

key String: Tag key.
value String: Tag value.

key string: Tag key.
value string: Tag value.

key str: Tag key.
value str: Tag value.

key String: Tag key.
value String: Tag value.

GetVolumeTotalPerformance

Iops double: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
Throughput double: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

Iops float64: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
Throughput float64: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops Double: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput Double: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops number: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput number: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops float: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput float: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.

iops Number: Total IOPS of the disk, which is the sum of the baseline IOPS and extra IOPS.
throughput Number: The total throughput of the cloud disk is the sum of its baseline throughput and additional throughput.