published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
File storage vePFS is a newly launched high-throughput, low-latency, scalable parallel file system service designed to meet the high-throughput and low-latency data read/write requirements in high-performance computing scenarios. It can be widely used in HPC (high-performance computing), AI training or inference, energy exploration, industrial simulation, film rendering, life sciences, meteorological analysis, and other scenarios. vePFS also provides one-click deployment and integrated monitoring and alerting capabilities, eliminating deployment and maintenance costs while maximizing your business efficiency.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const vEPFSInstanceDemo = new volcenginecc.vepfs.Instance("VEPFSInstanceDemo", {
fileSystemName: "VEPFSInstanceDemo",
zoneId: "cn-beijing-a",
chargeType: "PayAsYouGo",
fileSystemType: "VePFS",
storeType: "Advance_100",
protocolType: "VePFS",
projectName: "default",
capacity: 8,
vpcId: "vpc-3nqt4kq87xn28931eclxxxxx",
subnetId: "subnet-1a0zgr5e7hslc8nvepkxxxxxx",
versionNumber: "1.4.0",
enableRestripe: true,
tags: [{
key: "env",
value: "test",
}],
});
import pulumi
import pulumi_volcenginecc as volcenginecc
v_epfs_instance_demo = volcenginecc.vepfs.Instance("VEPFSInstanceDemo",
file_system_name="VEPFSInstanceDemo",
zone_id="cn-beijing-a",
charge_type="PayAsYouGo",
file_system_type="VePFS",
store_type="Advance_100",
protocol_type="VePFS",
project_name="default",
capacity=8,
vpc_id="vpc-3nqt4kq87xn28931eclxxxxx",
subnet_id="subnet-1a0zgr5e7hslc8nvepkxxxxxx",
version_number="1.4.0",
enable_restripe=True,
tags=[{
"key": "env",
"value": "test",
}])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vepfs"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vepfs.NewInstance(ctx, "VEPFSInstanceDemo", &vepfs.InstanceArgs{
FileSystemName: pulumi.String("VEPFSInstanceDemo"),
ZoneId: pulumi.String("cn-beijing-a"),
ChargeType: pulumi.String("PayAsYouGo"),
FileSystemType: pulumi.String("VePFS"),
StoreType: pulumi.String("Advance_100"),
ProtocolType: pulumi.String("VePFS"),
ProjectName: pulumi.String("default"),
Capacity: pulumi.Int(8),
VpcId: pulumi.String("vpc-3nqt4kq87xn28931eclxxxxx"),
SubnetId: pulumi.String("subnet-1a0zgr5e7hslc8nvepkxxxxxx"),
VersionNumber: pulumi.String("1.4.0"),
EnableRestripe: pulumi.Bool(true),
Tags: vepfs.InstanceTagArray{
&vepfs.InstanceTagArgs{
Key: pulumi.String("env"),
Value: pulumi.String("test"),
},
},
})
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 vEPFSInstanceDemo = new Volcenginecc.Vepfs.Instance("VEPFSInstanceDemo", new()
{
FileSystemName = "VEPFSInstanceDemo",
ZoneId = "cn-beijing-a",
ChargeType = "PayAsYouGo",
FileSystemType = "VePFS",
StoreType = "Advance_100",
ProtocolType = "VePFS",
ProjectName = "default",
Capacity = 8,
VpcId = "vpc-3nqt4kq87xn28931eclxxxxx",
SubnetId = "subnet-1a0zgr5e7hslc8nvepkxxxxxx",
VersionNumber = "1.4.0",
EnableRestripe = true,
Tags = new[]
{
new Volcenginecc.Vepfs.Inputs.InstanceTagArgs
{
Key = "env",
Value = "test",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vepfs.Instance;
import com.volcengine.volcenginecc.vepfs.InstanceArgs;
import com.pulumi.volcenginecc.vepfs.inputs.InstanceTagArgs;
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 vEPFSInstanceDemo = new Instance("vEPFSInstanceDemo", InstanceArgs.builder()
.fileSystemName("VEPFSInstanceDemo")
.zoneId("cn-beijing-a")
.chargeType("PayAsYouGo")
.fileSystemType("VePFS")
.storeType("Advance_100")
.protocolType("VePFS")
.projectName("default")
.capacity(8)
.vpcId("vpc-3nqt4kq87xn28931eclxxxxx")
.subnetId("subnet-1a0zgr5e7hslc8nvepkxxxxxx")
.versionNumber("1.4.0")
.enableRestripe(true)
.tags(InstanceTagArgs.builder()
.key("env")
.value("test")
.build())
.build());
}
}
resources:
vEPFSInstanceDemo:
type: volcenginecc:vepfs:Instance
name: VEPFSInstanceDemo
properties:
fileSystemName: VEPFSInstanceDemo
zoneId: cn-beijing-a
chargeType: PayAsYouGo
fileSystemType: VePFS
storeType: Advance_100
protocolType: VePFS
projectName: default
capacity: 8
vpcId: vpc-3nqt4kq87xn28931eclxxxxx
subnetId: subnet-1a0zgr5e7hslc8nvepkxxxxxx
versionNumber: 1.4.0
enableRestripe: true
tags:
- key: env
value: test
Create Instance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);@overload
def Instance(resource_name: str,
args: InstanceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Instance(resource_name: str,
opts: Optional[ResourceOptions] = None,
file_system_name: Optional[str] = None,
zone_id: Optional[str] = None,
store_type: Optional[str] = None,
capacity: Optional[int] = None,
project_name: Optional[str] = None,
file_system_type: Optional[str] = None,
enable_restripe: Optional[bool] = None,
protocol_type: Optional[str] = None,
description: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
version_number: Optional[str] = None,
vpc_id: Optional[str] = None,
charge_type: Optional[str] = None)func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)
type: volcenginecc:vepfs:Instance
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 InstanceArgs
- 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 InstanceArgs
- 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 InstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Instance 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 Instance resource accepts the following input properties:
- Capacity int
- File system capacity, unit: TiB.
- File
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- Store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- Zone
Id string - Availability zone ID.
- Charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- Description string
- File system description.
- Enable
Restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- File
System stringType - File system type. Default is VePFS.
- Project
Name string - Project to which the file system belongs. Default is default.
- Protocol
Type string - Protocol type. Default is VePFS.
- Subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
List<Volcengine.
Instance Tag> - Version
Number string - File system version number.
- Vpc
Id string - Private network ID.
- Capacity int
- File system capacity, unit: TiB.
- File
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- Store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- Zone
Id string - Availability zone ID.
- Charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- Description string
- File system description.
- Enable
Restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- File
System stringType - File system type. Default is VePFS.
- Project
Name string - Project to which the file system belongs. Default is default.
- Protocol
Type string - Protocol type. Default is VePFS.
- Subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
[]Instance
Tag Args - Version
Number string - File system version number.
- Vpc
Id string - Private network ID.
- capacity Integer
- File system capacity, unit: TiB.
- file
System StringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- store
Type String - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- zone
Id String - Availability zone ID.
- charge
Type String - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- description String
- File system description.
- enable
Restripe Boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- file
System StringType - File system type. Default is VePFS.
- project
Name String - Project to which the file system belongs. Default is default.
- protocol
Type String - Protocol type. Default is VePFS.
- subnet
Id String - Subnet ID. The subnet must belong to the selected availability zone.
-
List<Instance
Tag> - version
Number String - File system version number.
- vpc
Id String - Private network ID.
- capacity number
- File system capacity, unit: TiB.
- file
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- zone
Id string - Availability zone ID.
- charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- description string
- File system description.
- enable
Restripe boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- file
System stringType - File system type. Default is VePFS.
- project
Name string - Project to which the file system belongs. Default is default.
- protocol
Type string - Protocol type. Default is VePFS.
- subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
Instance
Tag[] - version
Number string - File system version number.
- vpc
Id string - Private network ID.
- capacity int
- File system capacity, unit: TiB.
- file_
system_ strname - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- store_
type str - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- zone_
id str - Availability zone ID.
- charge_
type str - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- description str
- File system description.
- enable_
restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- file_
system_ strtype - File system type. Default is VePFS.
- project_
name str - Project to which the file system belongs. Default is default.
- protocol_
type str - Protocol type. Default is VePFS.
- subnet_
id str - Subnet ID. The subnet must belong to the selected availability zone.
-
Sequence[Instance
Tag Args] - version_
number str - File system version number.
- vpc_
id str - Private network ID.
- capacity Number
- File system capacity, unit: TiB.
- file
System StringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- store
Type String - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- zone
Id String - Availability zone ID.
- charge
Type String - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- description String
- File system description.
- enable
Restripe Boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- file
System StringType - File system type. Default is VePFS.
- project
Name String - Project to which the file system belongs. Default is default.
- protocol
Type String - Protocol type. Default is VePFS.
- subnet
Id String - Subnet ID. The subnet must belong to the selected availability zone.
- List<Property Map>
- version
Number String - File system version number.
- vpc
Id String - Private network ID.
Outputs
All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:
- Account
Id string - Account ID.
- Bandwidth int
- VePFS file system throughput limit.
- Capacity
Info Volcengine.Instance Capacity Info - Capacity information.
- Charge
Status string - Billing status. Default is Normal, indicating standard billing.
- Created
Time string - Creation time.
- Expire
Time string - Expiration time.
- File
System stringId - File system ID.
- Free
Time string - File system release time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Read
Bandwidth int - Read bandwidth value, unit: MB/s.
- Security
Group stringId - Security group ID for the generated auxiliary NIC.
- Status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- Stop
Service stringTime - File system shutdown time.
- Store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- Store
Type stringEn - Storage type English name.
- Updated
Time string - File system update time.
- Write
Bandwidth int - Write bandwidth value, measured in MB/s.
- Zone
Name string - Availability zone name.
- Account
Id string - Account ID.
- Bandwidth int
- VePFS file system throughput limit.
- Capacity
Info InstanceCapacity Info - Capacity information.
- Charge
Status string - Billing status. Default is Normal, indicating standard billing.
- Created
Time string - Creation time.
- Expire
Time string - Expiration time.
- File
System stringId - File system ID.
- Free
Time string - File system release time.
- Id string
- The provider-assigned unique ID for this managed resource.
- Read
Bandwidth int - Read bandwidth value, unit: MB/s.
- Security
Group stringId - Security group ID for the generated auxiliary NIC.
- Status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- Stop
Service stringTime - File system shutdown time.
- Store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- Store
Type stringEn - Storage type English name.
- Updated
Time string - File system update time.
- Write
Bandwidth int - Write bandwidth value, measured in MB/s.
- Zone
Name string - Availability zone name.
- account
Id String - Account ID.
- bandwidth Integer
- VePFS file system throughput limit.
- capacity
Info InstanceCapacity Info - Capacity information.
- charge
Status String - Billing status. Default is Normal, indicating standard billing.
- created
Time String - Creation time.
- expire
Time String - Expiration time.
- file
System StringId - File system ID.
- free
Time String - File system release time.
- id String
- The provider-assigned unique ID for this managed resource.
- read
Bandwidth Integer - Read bandwidth value, unit: MB/s.
- security
Group StringId - Security group ID for the generated auxiliary NIC.
- status String
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service StringTime - File system shutdown time.
- store
Type StringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type StringEn - Storage type English name.
- updated
Time String - File system update time.
- write
Bandwidth Integer - Write bandwidth value, measured in MB/s.
- zone
Name String - Availability zone name.
- account
Id string - Account ID.
- bandwidth number
- VePFS file system throughput limit.
- capacity
Info InstanceCapacity Info - Capacity information.
- charge
Status string - Billing status. Default is Normal, indicating standard billing.
- created
Time string - Creation time.
- expire
Time string - Expiration time.
- file
System stringId - File system ID.
- free
Time string - File system release time.
- id string
- The provider-assigned unique ID for this managed resource.
- read
Bandwidth number - Read bandwidth value, unit: MB/s.
- security
Group stringId - Security group ID for the generated auxiliary NIC.
- status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service stringTime - File system shutdown time.
- store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type stringEn - Storage type English name.
- updated
Time string - File system update time.
- write
Bandwidth number - Write bandwidth value, measured in MB/s.
- zone
Name string - Availability zone name.
- account_
id str - Account ID.
- bandwidth int
- VePFS file system throughput limit.
- capacity_
info InstanceCapacity Info - Capacity information.
- charge_
status str - Billing status. Default is Normal, indicating standard billing.
- created_
time str - Creation time.
- expire_
time str - Expiration time.
- file_
system_ strid - File system ID.
- free_
time str - File system release time.
- id str
- The provider-assigned unique ID for this managed resource.
- read_
bandwidth int - Read bandwidth value, unit: MB/s.
- security_
group_ strid - Security group ID for the generated auxiliary NIC.
- status str
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop_
service_ strtime - File system shutdown time.
- store_
type_ strcn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store_
type_ stren - Storage type English name.
- updated_
time str - File system update time.
- write_
bandwidth int - Write bandwidth value, measured in MB/s.
- zone_
name str - Availability zone name.
- account
Id String - Account ID.
- bandwidth Number
- VePFS file system throughput limit.
- capacity
Info Property Map - Capacity information.
- charge
Status String - Billing status. Default is Normal, indicating standard billing.
- created
Time String - Creation time.
- expire
Time String - Expiration time.
- file
System StringId - File system ID.
- free
Time String - File system release time.
- id String
- The provider-assigned unique ID for this managed resource.
- read
Bandwidth Number - Read bandwidth value, unit: MB/s.
- security
Group StringId - Security group ID for the generated auxiliary NIC.
- status String
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service StringTime - File system shutdown time.
- store
Type StringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type StringEn - Storage type English name.
- updated
Time String - File system update time.
- write
Bandwidth Number - Write bandwidth value, measured in MB/s.
- zone
Name String - Availability zone name.
Look up Existing Instance Resource
Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
bandwidth: Optional[int] = None,
capacity: Optional[int] = None,
capacity_info: Optional[InstanceCapacityInfoArgs] = None,
charge_status: Optional[str] = None,
charge_type: Optional[str] = None,
created_time: Optional[str] = None,
description: Optional[str] = None,
enable_restripe: Optional[bool] = None,
expire_time: Optional[str] = None,
file_system_id: Optional[str] = None,
file_system_name: Optional[str] = None,
file_system_type: Optional[str] = None,
free_time: Optional[str] = None,
project_name: Optional[str] = None,
protocol_type: Optional[str] = None,
read_bandwidth: Optional[int] = None,
security_group_id: Optional[str] = None,
status: Optional[str] = None,
stop_service_time: Optional[str] = None,
store_type: Optional[str] = None,
store_type_cn: Optional[str] = None,
store_type_en: Optional[str] = None,
subnet_id: Optional[str] = None,
tags: Optional[Sequence[InstanceTagArgs]] = None,
updated_time: Optional[str] = None,
version_number: Optional[str] = None,
vpc_id: Optional[str] = None,
write_bandwidth: Optional[int] = None,
zone_id: Optional[str] = None,
zone_name: Optional[str] = None) -> Instancefunc GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)resources: _: type: volcenginecc:vepfs:Instance 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.
- Account
Id string - Account ID.
- Bandwidth int
- VePFS file system throughput limit.
- Capacity int
- File system capacity, unit: TiB.
- Capacity
Info Volcengine.Instance Capacity Info - Capacity information.
- Charge
Status string - Billing status. Default is Normal, indicating standard billing.
- Charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- Created
Time string - Creation time.
- Description string
- File system description.
- Enable
Restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- Expire
Time string - Expiration time.
- File
System stringId - File system ID.
- File
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- File
System stringType - File system type. Default is VePFS.
- Free
Time string - File system release time.
- Project
Name string - Project to which the file system belongs. Default is default.
- Protocol
Type string - Protocol type. Default is VePFS.
- Read
Bandwidth int - Read bandwidth value, unit: MB/s.
- Security
Group stringId - Security group ID for the generated auxiliary NIC.
- Status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- Stop
Service stringTime - File system shutdown time.
- Store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- Store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- Store
Type stringEn - Storage type English name.
- Subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
List<Volcengine.
Instance Tag> - Updated
Time string - File system update time.
- Version
Number string - File system version number.
- Vpc
Id string - Private network ID.
- Write
Bandwidth int - Write bandwidth value, measured in MB/s.
- Zone
Id string - Availability zone ID.
- Zone
Name string - Availability zone name.
- Account
Id string - Account ID.
- Bandwidth int
- VePFS file system throughput limit.
- Capacity int
- File system capacity, unit: TiB.
- Capacity
Info InstanceCapacity Info Args - Capacity information.
- Charge
Status string - Billing status. Default is Normal, indicating standard billing.
- Charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- Created
Time string - Creation time.
- Description string
- File system description.
- Enable
Restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- Expire
Time string - Expiration time.
- File
System stringId - File system ID.
- File
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- File
System stringType - File system type. Default is VePFS.
- Free
Time string - File system release time.
- Project
Name string - Project to which the file system belongs. Default is default.
- Protocol
Type string - Protocol type. Default is VePFS.
- Read
Bandwidth int - Read bandwidth value, unit: MB/s.
- Security
Group stringId - Security group ID for the generated auxiliary NIC.
- Status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- Stop
Service stringTime - File system shutdown time.
- Store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- Store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- Store
Type stringEn - Storage type English name.
- Subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
[]Instance
Tag Args - Updated
Time string - File system update time.
- Version
Number string - File system version number.
- Vpc
Id string - Private network ID.
- Write
Bandwidth int - Write bandwidth value, measured in MB/s.
- Zone
Id string - Availability zone ID.
- Zone
Name string - Availability zone name.
- account
Id String - Account ID.
- bandwidth Integer
- VePFS file system throughput limit.
- capacity Integer
- File system capacity, unit: TiB.
- capacity
Info InstanceCapacity Info - Capacity information.
- charge
Status String - Billing status. Default is Normal, indicating standard billing.
- charge
Type String - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- created
Time String - Creation time.
- description String
- File system description.
- enable
Restripe Boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- expire
Time String - Expiration time.
- file
System StringId - File system ID.
- file
System StringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- file
System StringType - File system type. Default is VePFS.
- free
Time String - File system release time.
- project
Name String - Project to which the file system belongs. Default is default.
- protocol
Type String - Protocol type. Default is VePFS.
- read
Bandwidth Integer - Read bandwidth value, unit: MB/s.
- security
Group StringId - Security group ID for the generated auxiliary NIC.
- status String
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service StringTime - File system shutdown time.
- store
Type String - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- store
Type StringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type StringEn - Storage type English name.
- subnet
Id String - Subnet ID. The subnet must belong to the selected availability zone.
-
List<Instance
Tag> - updated
Time String - File system update time.
- version
Number String - File system version number.
- vpc
Id String - Private network ID.
- write
Bandwidth Integer - Write bandwidth value, measured in MB/s.
- zone
Id String - Availability zone ID.
- zone
Name String - Availability zone name.
- account
Id string - Account ID.
- bandwidth number
- VePFS file system throughput limit.
- capacity number
- File system capacity, unit: TiB.
- capacity
Info InstanceCapacity Info - Capacity information.
- charge
Status string - Billing status. Default is Normal, indicating standard billing.
- charge
Type string - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- created
Time string - Creation time.
- description string
- File system description.
- enable
Restripe boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- expire
Time string - Expiration time.
- file
System stringId - File system ID.
- file
System stringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- file
System stringType - File system type. Default is VePFS.
- free
Time string - File system release time.
- project
Name string - Project to which the file system belongs. Default is default.
- protocol
Type string - Protocol type. Default is VePFS.
- read
Bandwidth number - Read bandwidth value, unit: MB/s.
- security
Group stringId - Security group ID for the generated auxiliary NIC.
- status string
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service stringTime - File system shutdown time.
- store
Type string - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- store
Type stringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type stringEn - Storage type English name.
- subnet
Id string - Subnet ID. The subnet must belong to the selected availability zone.
-
Instance
Tag[] - updated
Time string - File system update time.
- version
Number string - File system version number.
- vpc
Id string - Private network ID.
- write
Bandwidth number - Write bandwidth value, measured in MB/s.
- zone
Id string - Availability zone ID.
- zone
Name string - Availability zone name.
- account_
id str - Account ID.
- bandwidth int
- VePFS file system throughput limit.
- capacity int
- File system capacity, unit: TiB.
- capacity_
info InstanceCapacity Info Args - Capacity information.
- charge_
status str - Billing status. Default is Normal, indicating standard billing.
- charge_
type str - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- created_
time str - Creation time.
- description str
- File system description.
- enable_
restripe bool - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- expire_
time str - Expiration time.
- file_
system_ strid - File system ID.
- file_
system_ strname - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- file_
system_ strtype - File system type. Default is VePFS.
- free_
time str - File system release time.
- project_
name str - Project to which the file system belongs. Default is default.
- protocol_
type str - Protocol type. Default is VePFS.
- read_
bandwidth int - Read bandwidth value, unit: MB/s.
- security_
group_ strid - Security group ID for the generated auxiliary NIC.
- status str
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop_
service_ strtime - File system shutdown time.
- store_
type str - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- store_
type_ strcn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store_
type_ stren - Storage type English name.
- subnet_
id str - Subnet ID. The subnet must belong to the selected availability zone.
-
Sequence[Instance
Tag Args] - updated_
time str - File system update time.
- version_
number str - File system version number.
- vpc_
id str - Private network ID.
- write_
bandwidth int - Write bandwidth value, measured in MB/s.
- zone_
id str - Availability zone ID.
- zone_
name str - Availability zone name.
- account
Id String - Account ID.
- bandwidth Number
- VePFS file system throughput limit.
- capacity Number
- File system capacity, unit: TiB.
- capacity
Info Property Map - Capacity information.
- charge
Status String - Billing status. Default is Normal, indicating standard billing.
- charge
Type String - Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
- created
Time String - Creation time.
- description String
- File system description.
- enable
Restripe Boolean - Whether to enable data balancing after expansion. Value description: true: Enable data balancing immediately after expansion. false: Do not enable data balancing after expansion. Note: Only file systems with a specification of 100MB/s/TiB support the data balancing feature. Because the data balancing process consumes the network and disk bandwidth of storage nodes and causes file system performance degradation, we recommend that you evaluate your business needs and enable with caution. The duration of data balancing mainly depends on the amount of existing data. If you have a large amount of existing data, the balancing process may take longer. Depending on the expansion size and file system status, this process may take several hours to up to 2 days. We recommend enabling it during off-peak hours and waiting patiently.
- expire
Time String - Expiration time.
- file
System StringId - File system ID.
- file
System StringName - File system name. Naming rules are as follows: Must start with a Chinese or English letter. Can only contain Chinese characters, letters, numbers, period (.), underscore (_), or hyphen (-). Length must be between 1 and 128 characters.
- file
System StringType - File system type. Default is VePFS.
- free
Time String - File system release time.
- project
Name String - Project to which the file system belongs. Default is default.
- protocol
Type String - Protocol type. Default is VePFS.
- read
Bandwidth Number - Read bandwidth value, unit: MB/s.
- security
Group StringId - Security group ID for the generated auxiliary NIC.
- status String
- File system status. Value descriptions are as follows: Running: Instance is running. Creating: Instance is being created. CreateError: Instance creation failed. Updating: Instance is being updated. UpdateError: Instance update failed. Expanding: Instance is being expanded. ExpandError: Instance expansion failed. Deleting: Instance is being deleted. DeleteError: Instance deletion failed. Stopped: Instance is stopped. Error: Instance is in an error state.
- stop
Service StringTime - File system shutdown time.
- store
Type String - File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
- store
Type StringCn - File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
- store
Type StringEn - Storage type English name.
- subnet
Id String - Subnet ID. The subnet must belong to the selected availability zone.
- List<Property Map>
- updated
Time String - File system update time.
- version
Number String - File system version number.
- vpc
Id String - Private network ID.
- write
Bandwidth Number - Write bandwidth value, measured in MB/s.
- zone
Id String - Availability zone ID.
- zone
Name String - Availability zone name.
Supporting Types
InstanceCapacityInfo, InstanceCapacityInfoArgs
- Total
Ti intB - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- Used
Gi intB - Used capacity (GiB).
- Total
Ti intB - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- Used
Gi intB - Used capacity (GiB).
- total
Ti IntegerB - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- used
Gi IntegerB - Used capacity (GiB).
- total
Ti numberB - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- used
Gi numberB - Used capacity (GiB).
- total_
ti_ intb - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- used_
gi_ intb - Used capacity (GiB).
- total
Ti NumberB - Total file system capacity, unit: TiB. Note: Disk balancing time varies based on cluster capacity, cluster load, and other factors. For clusters above the PiB level, expansion typically requires day-level disk balancing time. The expansion capacity becomes effective (and is billed) only after disk balancing is complete.
- used
Gi NumberB - Used capacity (GiB).
InstanceTag, InstanceTagArgs
Import
$ pulumi import volcenginecc:vepfs/instance:Instance example "file_system_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
