volcenginecc.vepfs.getInstance

volcenginecc v0.0.32, Apr 23 26

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

Schema (JSON)

volcengine/pulumi-volcenginecc

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

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:vepfs/getInstance:getInstance
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getInstance Result

The following output properties are available:

AccountId string: Account ID.
Bandwidth int: VePFS file system throughput limit.
Capacity int: File system capacity, unit: TiB.
CapacityInfo Volcengine.GetInstanceCapacityInfo: Capacity information.
ChargeStatus string: Billing status. Default is Normal, indicating standard billing.
ChargeType string: Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
CreatedTime string: Creation time.
Description string: File system description.
EnableRestripe 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.
ExpireTime string: Expiration time.
FileSystemId string: File system ID.
FileSystemName string: 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.
FileSystemType string: File system type. Default is VePFS.
FreeTime string: File system release time.
Id string: Uniquely identifies the resource.
ProjectName string: Project to which the file system belongs. Default is default.
ProtocolType string: Protocol type. Default is VePFS.
ReadBandwidth int: Read bandwidth value, unit: MB/s.
SecurityGroupId string: 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.
StopServiceTime string: File system shutdown time.
StoreType string: File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
StoreTypeCn string: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
StoreTypeEn string: Storage type English name.
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.
Tags List<Volcengine.GetInstanceTag>: Tag list.
UpdatedTime string: File system update time.
VersionNumber string: File system version number.
VpcId string: Private network ID.
WriteBandwidth int: Write bandwidth value, measured in MB/s.
ZoneId string: Availability zone ID.
ZoneName string: Availability zone name.

AccountId string: Account ID.
Bandwidth int: VePFS file system throughput limit.
Capacity int: File system capacity, unit: TiB.
CapacityInfo GetInstanceCapacityInfo: Capacity information.
ChargeStatus string: Billing status. Default is Normal, indicating standard billing.
ChargeType string: Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
CreatedTime string: Creation time.
Description string: File system description.
EnableRestripe 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.
ExpireTime string: Expiration time.
FileSystemId string: File system ID.
FileSystemName string: 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.
FileSystemType string: File system type. Default is VePFS.
FreeTime string: File system release time.
Id string: Uniquely identifies the resource.
ProjectName string: Project to which the file system belongs. Default is default.
ProtocolType string: Protocol type. Default is VePFS.
ReadBandwidth int: Read bandwidth value, unit: MB/s.
SecurityGroupId string: 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.
StopServiceTime string: File system shutdown time.
StoreType string: File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
StoreTypeCn string: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
StoreTypeEn string: Storage type English name.
SubnetId string: Subnet ID. The subnet must belong to the selected availability zone.
Tags []GetInstanceTag: Tag list.
UpdatedTime string: File system update time.
VersionNumber string: File system version number.
VpcId string: Private network ID.
WriteBandwidth int: Write bandwidth value, measured in MB/s.
ZoneId string: Availability zone ID.
ZoneName string: Availability zone name.

accountId String: Account ID.
bandwidth Integer: VePFS file system throughput limit.
capacity Integer: File system capacity, unit: TiB.
capacityInfo GetInstanceCapacityInfo: Capacity information.
chargeStatus String: Billing status. Default is Normal, indicating standard billing.
chargeType String: Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
createdTime String: Creation time.
description String: File system description.
enableRestripe 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.
expireTime String: Expiration time.
fileSystemId String: File system ID.
fileSystemName String: 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.
fileSystemType String: File system type. Default is VePFS.
freeTime String: File system release time.
id String: Uniquely identifies the resource.
projectName String: Project to which the file system belongs. Default is default.
protocolType String: Protocol type. Default is VePFS.
readBandwidth Integer: Read bandwidth value, unit: MB/s.
securityGroupId String: 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.
stopServiceTime String: File system shutdown time.
storeType String: File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
storeTypeCn String: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
storeTypeEn String: Storage type English name.
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.
tags List<GetInstanceTag>: Tag list.
updatedTime String: File system update time.
versionNumber String: File system version number.
vpcId String: Private network ID.
writeBandwidth Integer: Write bandwidth value, measured in MB/s.
zoneId String: Availability zone ID.
zoneName String: Availability zone name.

accountId string: Account ID.
bandwidth number: VePFS file system throughput limit.
capacity number: File system capacity, unit: TiB.
capacityInfo GetInstanceCapacityInfo: Capacity information.
chargeStatus string: Billing status. Default is Normal, indicating standard billing.
chargeType string: Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
createdTime string: Creation time.
description string: File system description.
enableRestripe 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.
expireTime string: Expiration time.
fileSystemId string: File system ID.
fileSystemName string: 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.
fileSystemType string: File system type. Default is VePFS.
freeTime string: File system release time.
id string: Uniquely identifies the resource.
projectName string: Project to which the file system belongs. Default is default.
protocolType string: Protocol type. Default is VePFS.
readBandwidth number: Read bandwidth value, unit: MB/s.
securityGroupId string: 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.
stopServiceTime string: File system shutdown time.
storeType string: File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
storeTypeCn string: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
storeTypeEn string: Storage type English name.
subnetId string: Subnet ID. The subnet must belong to the selected availability zone.
tags GetInstanceTag[]: Tag list.
updatedTime string: File system update time.
versionNumber string: File system version number.
vpcId string: Private network ID.
writeBandwidth number: Write bandwidth value, measured in MB/s.
zoneId string: Availability zone ID.
zoneName 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 GetInstanceCapacityInfo: 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_id str: File system ID.
file_system_name str: 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_type str: File system type. Default is VePFS.
free_time str: File system release time.
id str: Uniquely identifies the resource.
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_id str: 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_time str: 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_cn str: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
store_type_en str: Storage type English name.
subnet_id str: Subnet ID. The subnet must belong to the selected availability zone.
tags Sequence[GetInstanceTag]: Tag list.
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.

accountId String: Account ID.
bandwidth Number: VePFS file system throughput limit.
capacity Number: File system capacity, unit: TiB.
capacityInfo Property Map: Capacity information.
chargeStatus String: Billing status. Default is Normal, indicating standard billing.
chargeType String: Billing type. Value descriptions are as follows: PayAsYouGo: Pay-as-you-go billing.
createdTime String: Creation time.
description String: File system description.
enableRestripe 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.
expireTime String: Expiration time.
fileSystemId String: File system ID.
fileSystemName String: 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.
fileSystemType String: File system type. Default is VePFS.
freeTime String: File system release time.
id String: Uniquely identifies the resource.
projectName String: Project to which the file system belongs. Default is default.
protocolType String: Protocol type. Default is VePFS.
readBandwidth Number: Read bandwidth value, unit: MB/s.
securityGroupId String: 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.
stopServiceTime String: File system shutdown time.
storeType String: File system specification. Value descriptions are as follows: Advance100: 100MB/s/TiB. Performance: Performance. IntelligentComputing: Intelligent Computing.
storeTypeCn String: File system specification name in Chinese. Supported options: 100MB/s/TiB. Performance. Intelligent Computing.
storeTypeEn String: Storage type English name.
subnetId String: Subnet ID. The subnet must belong to the selected availability zone.
tags List<Property Map>: Tag list.
updatedTime String: File system update time.
versionNumber String: File system version number.
vpcId String: Private network ID.
writeBandwidth Number: Write bandwidth value, measured in MB/s.
zoneId String: Availability zone ID.
zoneName String: Availability zone name.

Supporting Types

GetInstanceCapacityInfo

TotalTiB int: 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.
UsedGiB int: Used capacity (GiB).

TotalTiB int: 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.
UsedGiB int: Used capacity (GiB).

totalTiB Integer: 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.
usedGiB Integer: Used capacity (GiB).

totalTiB number: 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.
usedGiB number: Used capacity (GiB).

total_ti_b int: 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_b int: Used capacity (GiB).

totalTiB Number: 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.
usedGiB Number: Used capacity (GiB).

GetInstanceTag

Key string: User tag key.
Type string: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
Value string: User tag value.

Key string: User tag key.
Type string: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
Value string: User tag value.

key String: User tag key.
type String: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
value String: User tag value.

key string: User tag key.
type string: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
value string: User tag value.

key str: User tag key.
type str: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
value str: User tag value.

key String: User tag key.
type String: Tag type. Descriptions are as follows: Custom: User-defined tag. System: System tag.
value String: User tag value.