published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
Cloud disk is a block storage device with high availability, high reliability, high performance, and elastic scalability. It can be used as a scalable disk for cloud servers and elastic container services.
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,
tags: Optional[Sequence[VolumeTagArgs]] = 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",
Tags = new[]
{
new Volcenginecc.Storageebs.Inputs.VolumeTagArgs
{
Key = "string",
Value = "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"),
Tags: storageebs.VolumeTagArray{
&storageebs.VolumeTagArgs{
Key: pulumi.String("string"),
Value: 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")
.tags(VolumeTagArgs.builder()
.key("string")
.value("string")
.build())
.extraPerformance(VolumeExtraPerformanceArgs.builder()
.extraPerformanceTypeId("string")
.iops(0.0)
.throughput(0.0)
.build())
.description("string")
.deleteWithInstance(false)
.build());
volume_resource = volcenginecc.storageebs.Volume("volumeResource",
size=float(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",
tags=[{
"key": "string",
"value": "string",
}],
extra_performance={
"extra_performance_type_id": "string",
"iops": float(0),
"throughput": float(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",
tags: [{
key: "string",
value: "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
tags:
- key: string
value: 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: 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
- Volume
Name 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.
- Volume
Type string - 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 string - Availability zone ID.
- Auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- Delete
With boolInstance - 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.
- Extra
Performance Volcengine.Volume Extra Performance - Extra performance.
- Instance
Id 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.
- Pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- Project
Name string - Project name to which the disk will be added.
- Source
Snapshot stringId - Source snapshot.
-
List<Volcengine.
Volume Tag>
- 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
- Volume
Name 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.
- Volume
Type string - 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 string - Availability zone ID.
- Auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- Delete
With boolInstance - 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.
- Extra
Performance VolumeExtra Performance Args - Extra performance.
- Instance
Id 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.
- Pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- Project
Name string - Project name to which the disk will be added.
- Source
Snapshot stringId - Source snapshot.
-
[]Volume
Tag Args
- 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
- volume
Name 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.
- volume
Type String - 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 String - Availability zone ID.
- auto
Snapshot StringPolicy Id - Automatic snapshot policy ID.
- delete
With BooleanInstance - 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.
- extra
Performance VolumeExtra Performance - Extra performance.
- instance
Id 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.
- pay
Type String - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name String - Project name to which the disk will be added.
- source
Snapshot StringId - Source snapshot.
-
List<Volume
Tag>
- 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
- volume
Name 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.
- volume
Type string - 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 string - Availability zone ID.
- auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- delete
With booleanInstance - 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.
- extra
Performance VolumeExtra Performance - Extra performance.
- instance
Id 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.
- pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name string - Project name to which the disk will be added.
- source
Snapshot stringId - Source snapshot.
-
Volume
Tag[]
- 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
- 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.
- auto_
snapshot_ strpolicy_ id - Automatic snapshot policy ID.
- delete_
with_ boolinstance - 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.
- extra_
performance VolumeExtra Performance Args - Extra performance.
- 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.
- 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.
- source_
snapshot_ strid - Source snapshot.
-
Sequence[Volume
Tag Args]
- 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
- volume
Name 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.
- volume
Type String - 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 String - Availability zone ID.
- auto
Snapshot StringPolicy Id - Automatic snapshot policy ID.
- delete
With BooleanInstance - 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.
- extra
Performance Property Map - Extra performance.
- instance
Id 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.
- pay
Type String - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name String - Project name to which the disk will be added.
- source
Snapshot StringId - Source snapshot.
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:
- Auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- Baseline
Performance Volcengine.Volume Baseline Performance - Baseline performance.
- Created
At string - Disk creation time.
- Device
Name string - Device name
- Error
Detail string - Specific error
- Expired
Time string - Expiration time for yearly/monthly subscription.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - Image ID in the disk.
- Overdue
Reclaim stringTime - Disk overdue reclamation time.
- Overdue
Time string - Disk overdue shutdown time.
- Renew
Type double - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- Snapshot
Count double - Snapshot count.
- Status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- Total
Performance Volcengine.Volume Total Performance - Total performance.
- Trade
Status double - Transaction status 0: Creating 1: Running 2: Creation failed
- Updated
At string - Disk update time.
- Volume
Id string - Disk ID.
- Auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- Baseline
Performance VolumeBaseline Performance - Baseline performance.
- Created
At string - Disk creation time.
- Device
Name string - Device name
- Error
Detail string - Specific error
- Expired
Time string - Expiration time for yearly/monthly subscription.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - Image ID in the disk.
- Overdue
Reclaim stringTime - Disk overdue reclamation time.
- Overdue
Time string - Disk overdue shutdown time.
- Renew
Type float64 - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- Snapshot
Count float64 - Snapshot count.
- Status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- Total
Performance VolumeTotal Performance - Total performance.
- Trade
Status float64 - Transaction status 0: Creating 1: Running 2: Creation failed
- Updated
At string - Disk update time.
- Volume
Id string - Disk ID.
- auto
Snapshot StringPolicy Name - Automatic snapshot policy name.
- baseline
Performance VolumeBaseline Performance - Baseline performance.
- created
At String - Disk creation time.
- device
Name String - Device name
- error
Detail String - Specific error
- expired
Time String - Expiration time for yearly/monthly subscription.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - Image ID in the disk.
- overdue
Reclaim StringTime - Disk overdue reclamation time.
- overdue
Time String - Disk overdue shutdown time.
- renew
Type Double - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- snapshot
Count Double - Snapshot count.
- status String
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- total
Performance VolumeTotal Performance - Total performance.
- trade
Status Double - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At String - Disk update time.
- volume
Id String - Disk ID.
- auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- baseline
Performance VolumeBaseline Performance - Baseline performance.
- created
At string - Disk creation time.
- device
Name string - Device name
- error
Detail string - Specific error
- expired
Time string - Expiration time for yearly/monthly subscription.
- id string
- The provider-assigned unique ID for this managed resource.
- image
Id string - Image ID in the disk.
- overdue
Reclaim stringTime - Disk overdue reclamation time.
- overdue
Time string - Disk overdue shutdown time.
- renew
Type number - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- snapshot
Count number - Snapshot count.
- status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- total
Performance VolumeTotal Performance - Total performance.
- trade
Status number - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At string - Disk update time.
- volume
Id string - Disk ID.
- auto_
snapshot_ strpolicy_ name - Automatic snapshot policy name.
- baseline_
performance VolumeBaseline Performance - Baseline performance.
- created_
at str - Disk creation time.
- device_
name str - Device name
- error_
detail str - Specific error
- expired_
time str - Expiration time for yearly/monthly subscription.
- id str
- The provider-assigned unique ID for this managed resource.
- image_
id str - Image ID in the disk.
- overdue_
reclaim_ strtime - Disk overdue reclamation time.
- overdue_
time str - Disk overdue shutdown time.
- renew_
type float - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- snapshot_
count float - Snapshot count.
- status str
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- total_
performance VolumeTotal Performance - 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.
- auto
Snapshot StringPolicy Name - Automatic snapshot policy name.
- baseline
Performance Property Map - Baseline performance.
- created
At String - Disk creation time.
- device
Name String - Device name
- error
Detail String - Specific error
- expired
Time String - Expiration time for yearly/monthly subscription.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - Image ID in the disk.
- overdue
Reclaim StringTime - Disk overdue reclamation time.
- overdue
Time String - Disk overdue shutdown time.
- renew
Type Number - Renewal method 1: Manual renewal 2: Automatic renewal 3: Do not renew upon expiration.
- snapshot
Count Number - Snapshot count.
- status String
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- total
Performance Property Map - Total performance.
- trade
Status Number - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At String - Disk update time.
- volume
Id String - Disk 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,
tags: Optional[Sequence[VolumeTagArgs]] = 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) -> Volumefunc 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.
- Auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- Auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- Baseline
Performance Volcengine.Volume Baseline Performance - Baseline performance.
- Created
At string - Disk creation time.
- Delete
With boolInstance - 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.
- Device
Name string - Device name
- Error
Detail string - Specific error
- Expired
Time string - Expiration time for yearly/monthly subscription.
- Extra
Performance Volcengine.Volume Extra Performance - Extra performance.
- Image
Id string - Image ID in the disk.
- Instance
Id 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.
- Overdue
Reclaim stringTime - Disk overdue reclamation time.
- Overdue
Time string - Disk overdue shutdown time.
- Pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- Project
Name string - Project name to which the disk will be added.
- Renew
Type 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
- Snapshot
Count double - Snapshot count.
- Source
Snapshot stringId - Source snapshot.
- Status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
-
List<Volcengine.
Volume Tag> - Total
Performance Volcengine.Volume Total Performance - Total performance.
- Trade
Status double - Transaction status 0: Creating 1: Running 2: Creation failed
- Updated
At string - Disk update time.
- Volume
Id string - Disk ID.
- Volume
Name 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.
- Volume
Type string - 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 string - Availability zone ID.
- Auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- Auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- Baseline
Performance VolumeBaseline Performance Args - Baseline performance.
- Created
At string - Disk creation time.
- Delete
With boolInstance - 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.
- Device
Name string - Device name
- Error
Detail string - Specific error
- Expired
Time string - Expiration time for yearly/monthly subscription.
- Extra
Performance VolumeExtra Performance Args - Extra performance.
- Image
Id string - Image ID in the disk.
- Instance
Id 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.
- Overdue
Reclaim stringTime - Disk overdue reclamation time.
- Overdue
Time string - Disk overdue shutdown time.
- Pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- Project
Name string - Project name to which the disk will be added.
- Renew
Type 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
- Snapshot
Count float64 - Snapshot count.
- Source
Snapshot stringId - Source snapshot.
- Status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
-
[]Volume
Tag Args - Total
Performance VolumeTotal Performance Args - Total performance.
- Trade
Status float64 - Transaction status 0: Creating 1: Running 2: Creation failed
- Updated
At string - Disk update time.
- Volume
Id string - Disk ID.
- Volume
Name 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.
- Volume
Type string - 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 string - Availability zone ID.
- auto
Snapshot StringPolicy Id - Automatic snapshot policy ID.
- auto
Snapshot StringPolicy Name - Automatic snapshot policy name.
- baseline
Performance VolumeBaseline Performance - Baseline performance.
- created
At String - Disk creation time.
- delete
With BooleanInstance - 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.
- device
Name String - Device name
- error
Detail String - Specific error
- expired
Time String - Expiration time for yearly/monthly subscription.
- extra
Performance VolumeExtra Performance - Extra performance.
- image
Id String - Image ID in the disk.
- instance
Id 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.
- overdue
Reclaim StringTime - Disk overdue reclamation time.
- overdue
Time String - Disk overdue shutdown time.
- pay
Type String - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name String - Project name to which the disk will be added.
- renew
Type 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
- snapshot
Count Double - Snapshot count.
- source
Snapshot StringId - Source snapshot.
- status String
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
-
List<Volume
Tag> - total
Performance VolumeTotal Performance - Total performance.
- trade
Status Double - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At String - Disk update time.
- volume
Id String - Disk ID.
- volume
Name 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.
- volume
Type String - 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 String - Availability zone ID.
- auto
Snapshot stringPolicy Id - Automatic snapshot policy ID.
- auto
Snapshot stringPolicy Name - Automatic snapshot policy name.
- baseline
Performance VolumeBaseline Performance - Baseline performance.
- created
At string - Disk creation time.
- delete
With booleanInstance - 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.
- device
Name string - Device name
- error
Detail string - Specific error
- expired
Time string - Expiration time for yearly/monthly subscription.
- extra
Performance VolumeExtra Performance - Extra performance.
- image
Id string - Image ID in the disk.
- instance
Id 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.
- overdue
Reclaim stringTime - Disk overdue reclamation time.
- overdue
Time string - Disk overdue shutdown time.
- pay
Type string - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name string - Project name to which the disk will be added.
- renew
Type 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
- snapshot
Count number - Snapshot count.
- source
Snapshot stringId - Source snapshot.
- status string
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
-
Volume
Tag[] - total
Performance VolumeTotal Performance - Total performance.
- trade
Status number - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At string - Disk update time.
- volume
Id string - Disk ID.
- volume
Name 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.
- volume
Type string - 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 string - Availability zone ID.
- auto_
snapshot_ strpolicy_ id - Automatic snapshot policy ID.
- auto_
snapshot_ strpolicy_ name - Automatic snapshot policy name.
- baseline_
performance VolumeBaseline Performance Args - Baseline performance.
- created_
at str - Disk creation time.
- delete_
with_ boolinstance - 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 VolumeExtra Performance Args - Extra performance.
- 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_ strtime - 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_ strid - Source snapshot.
- status str
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
-
Sequence[Volume
Tag Args] - total_
performance VolumeTotal Performance Args - 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.
- auto
Snapshot StringPolicy Id - Automatic snapshot policy ID.
- auto
Snapshot StringPolicy Name - Automatic snapshot policy name.
- baseline
Performance Property Map - Baseline performance.
- created
At String - Disk creation time.
- delete
With BooleanInstance - 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.
- device
Name String - Device name
- error
Detail String - Specific error
- expired
Time String - Expiration time for yearly/monthly subscription.
- extra
Performance Property Map - Extra performance.
- image
Id String - Image ID in the disk.
- instance
Id 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.
- overdue
Reclaim StringTime - Disk overdue reclamation time.
- overdue
Time String - Disk overdue shutdown time.
- pay
Type String - Payment type. Description: Pre: Prepaid (annual/monthly). Post: Postpaid (pay-as-you-go).
- project
Name String - Project name to which the disk will be added.
- renew
Type 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
- snapshot
Count Number - Snapshot count.
- source
Snapshot StringId - Source snapshot.
- status String
- Disk status. Value description: available: Available. mounting: Mounting. mounted: Mounted. unmounting: Unmounting. creating: Creating. deleting: Deleting. error: Error. expanding: Expanding.
- List<Property Map>
- total
Performance Property Map - Total performance.
- trade
Status Number - Transaction status 0: Creating 1: Running 2: Creation failed
- updated
At String - Disk update time.
- volume
Id String - Disk ID.
- volume
Name 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.
- volume
Type String - 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 String - Availability zone ID.
Supporting Types
VolumeBaselinePerformance, VolumeBaselinePerformanceArgs
- 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.
VolumeExtraPerformance, VolumeExtraPerformanceArgs
- Extra
Performance stringType Id - 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.
- Extra
Performance stringType Id - 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.
- extra
Performance StringType Id - 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.
- extra
Performance stringType Id - 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_ strtype_ id - 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.
- extra
Performance StringType Id - 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.
VolumeTag, VolumeTagArgs
VolumeTotalPerformance, VolumeTotalPerformanceArgs
- 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.
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
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
