bytepluscc.vepfs.getInstance

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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: 账户ID。
Bandwidth int: vePFS 文件系统吞吐上限。
Capacity int: 文件系统容量，单位为 TiB。
CapacityInfo Byteplus.GetInstanceCapacityInfo: 容量信息。
ChargeStatus string: 计费状态，默认为 Normal，表示正常计费。
ChargeType string: 计费类型。取值说明如下：PayAsYouGo：按量计费。
CreatedTime string: 创建时间。
Description string: 文件系统描述信息。
EnableRestripe bool: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
ExpireTime string: 过期时间。
FileSystemId string: 文件系统 ID。
FileSystemName string: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
FileSystemType string: 文件系统类型，默认为 VePFS。
FreeTime string: 文件系统释放时间。
Id string: Uniquely identifies the resource.
ProjectName string: 文件系统所属项目，默认为 default。
ProtocolType string: 协议类型，默认为 VePFS。
ReadBandwidth int: 读带宽值, 单位MB/s。
SecurityGroupId string: 生成的辅助网卡所在的安全组ID。
Status string: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
StopServiceTime string: 文件系统关停时间。
StoreType string: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
StoreTypeCn string: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
StoreTypeEn string: 存储类型英文名。
SubnetId string: 子网 ID。子网必须属于所选的可用区。
Tags List<Byteplus.GetInstanceTag>: 标签列表。
UpdatedTime string: 文件系统更新时间。
VersionNumber string: 文件系统版本号。
VpcId string: 私有网络 ID。
WriteBandwidth int: 写带宽值, 单位MB/s。
ZoneId string: 可用区 ID。
ZoneName string: 可用区名称。

AccountId string: 账户ID。
Bandwidth int: vePFS 文件系统吞吐上限。
Capacity int: 文件系统容量，单位为 TiB。
CapacityInfo GetInstanceCapacityInfo: 容量信息。
ChargeStatus string: 计费状态，默认为 Normal，表示正常计费。
ChargeType string: 计费类型。取值说明如下：PayAsYouGo：按量计费。
CreatedTime string: 创建时间。
Description string: 文件系统描述信息。
EnableRestripe bool: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
ExpireTime string: 过期时间。
FileSystemId string: 文件系统 ID。
FileSystemName string: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
FileSystemType string: 文件系统类型，默认为 VePFS。
FreeTime string: 文件系统释放时间。
Id string: Uniquely identifies the resource.
ProjectName string: 文件系统所属项目，默认为 default。
ProtocolType string: 协议类型，默认为 VePFS。
ReadBandwidth int: 读带宽值, 单位MB/s。
SecurityGroupId string: 生成的辅助网卡所在的安全组ID。
Status string: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
StopServiceTime string: 文件系统关停时间。
StoreType string: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
StoreTypeCn string: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
StoreTypeEn string: 存储类型英文名。
SubnetId string: 子网 ID。子网必须属于所选的可用区。
Tags []GetInstanceTag: 标签列表。
UpdatedTime string: 文件系统更新时间。
VersionNumber string: 文件系统版本号。
VpcId string: 私有网络 ID。
WriteBandwidth int: 写带宽值, 单位MB/s。
ZoneId string: 可用区 ID。
ZoneName string: 可用区名称。

accountId String: 账户ID。
bandwidth Integer: vePFS 文件系统吞吐上限。
capacity Integer: 文件系统容量，单位为 TiB。
capacityInfo GetInstanceCapacityInfo: 容量信息。
chargeStatus String: 计费状态，默认为 Normal，表示正常计费。
chargeType String: 计费类型。取值说明如下：PayAsYouGo：按量计费。
createdTime String: 创建时间。
description String: 文件系统描述信息。
enableRestripe Boolean: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
expireTime String: 过期时间。
fileSystemId String: 文件系统 ID。
fileSystemName String: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
fileSystemType String: 文件系统类型，默认为 VePFS。
freeTime String: 文件系统释放时间。
id String: Uniquely identifies the resource.
projectName String: 文件系统所属项目，默认为 default。
protocolType String: 协议类型，默认为 VePFS。
readBandwidth Integer: 读带宽值, 单位MB/s。
securityGroupId String: 生成的辅助网卡所在的安全组ID。
status String: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
stopServiceTime String: 文件系统关停时间。
storeType String: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
storeTypeCn String: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
storeTypeEn String: 存储类型英文名。
subnetId String: 子网 ID。子网必须属于所选的可用区。
tags List<GetInstanceTag>: 标签列表。
updatedTime String: 文件系统更新时间。
versionNumber String: 文件系统版本号。
vpcId String: 私有网络 ID。
writeBandwidth Integer: 写带宽值, 单位MB/s。
zoneId String: 可用区 ID。
zoneName String: 可用区名称。

accountId string: 账户ID。
bandwidth number: vePFS 文件系统吞吐上限。
capacity number: 文件系统容量，单位为 TiB。
capacityInfo GetInstanceCapacityInfo: 容量信息。
chargeStatus string: 计费状态，默认为 Normal，表示正常计费。
chargeType string: 计费类型。取值说明如下：PayAsYouGo：按量计费。
createdTime string: 创建时间。
description string: 文件系统描述信息。
enableRestripe boolean: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
expireTime string: 过期时间。
fileSystemId string: 文件系统 ID。
fileSystemName string: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
fileSystemType string: 文件系统类型，默认为 VePFS。
freeTime string: 文件系统释放时间。
id string: Uniquely identifies the resource.
projectName string: 文件系统所属项目，默认为 default。
protocolType string: 协议类型，默认为 VePFS。
readBandwidth number: 读带宽值, 单位MB/s。
securityGroupId string: 生成的辅助网卡所在的安全组ID。
status string: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
stopServiceTime string: 文件系统关停时间。
storeType string: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
storeTypeCn string: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
storeTypeEn string: 存储类型英文名。
subnetId string: 子网 ID。子网必须属于所选的可用区。
tags GetInstanceTag[]: 标签列表。
updatedTime string: 文件系统更新时间。
versionNumber string: 文件系统版本号。
vpcId string: 私有网络 ID。
writeBandwidth number: 写带宽值, 单位MB/s。
zoneId string: 可用区 ID。
zoneName string: 可用区名称。

account_id str: 账户ID。
bandwidth int: vePFS 文件系统吞吐上限。
capacity int: 文件系统容量，单位为 TiB。
capacity_info GetInstanceCapacityInfo: 容量信息。
charge_status str: 计费状态，默认为 Normal，表示正常计费。
charge_type str: 计费类型。取值说明如下：PayAsYouGo：按量计费。
created_time str: 创建时间。
description str: 文件系统描述信息。
enable_restripe bool: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
expire_time str: 过期时间。
file_system_id str: 文件系统 ID。
file_system_name str: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
file_system_type str: 文件系统类型，默认为 VePFS。
free_time str: 文件系统释放时间。
id str: Uniquely identifies the resource.
project_name str: 文件系统所属项目，默认为 default。
protocol_type str: 协议类型，默认为 VePFS。
read_bandwidth int: 读带宽值, 单位MB/s。
security_group_id str: 生成的辅助网卡所在的安全组ID。
status str: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
stop_service_time str: 文件系统关停时间。
store_type str: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
store_type_cn str: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
store_type_en str: 存储类型英文名。
subnet_id str: 子网 ID。子网必须属于所选的可用区。
tags Sequence[GetInstanceTag]: 标签列表。
updated_time str: 文件系统更新时间。
version_number str: 文件系统版本号。
vpc_id str: 私有网络 ID。
write_bandwidth int: 写带宽值, 单位MB/s。
zone_id str: 可用区 ID。
zone_name str: 可用区名称。

accountId String: 账户ID。
bandwidth Number: vePFS 文件系统吞吐上限。
capacity Number: 文件系统容量，单位为 TiB。
capacityInfo Property Map: 容量信息。
chargeStatus String: 计费状态，默认为 Normal，表示正常计费。
chargeType String: 计费类型。取值说明如下：PayAsYouGo：按量计费。
createdTime String: 创建时间。
description String: 文件系统描述信息。
enableRestripe Boolean: 扩容后是否开启数据均衡，取值说明如下：true：扩容后立即开启数据均衡。false：扩容后不开启数据均衡。注意：仅 100MB/s/TiB 规格的文件系统支持数据均衡功能。由于数据均衡过程会消耗存储节点的网络和磁盘带宽，导致文件系统的性能下降，建议您评估业务需求，谨慎开启。数据均衡的时间主要受存量数据量的影响，如果您的存量数据较多，均衡的时间可能会较长，根据扩容容量大小和文件系统状态，此过程可能需要花费数小时至 2 天的时间，建议您在业务低峰期开启并耐心等待。
expireTime String: 过期时间。
fileSystemId String: 文件系统 ID。
fileSystemName String: 文件系统名称。命名规范如下：只能以中文或英文开头。只能包含中文、字母、数字、半角句号（.）、下划线（_）或中划线（-）。长度需要在 1~128 个字符内。
fileSystemType String: 文件系统类型，默认为 VePFS。
freeTime String: 文件系统释放时间。
id String: Uniquely identifies the resource.
projectName String: 文件系统所属项目，默认为 default。
protocolType String: 协议类型，默认为 VePFS。
readBandwidth Number: 读带宽值, 单位MB/s。
securityGroupId String: 生成的辅助网卡所在的安全组ID。
status String: 文件系统状态。取值说明如下：Running：实例运行中。Creating：实例创建中。CreateError：实例创建失败。Updating：实例更新中。UpdateError：实例更新失败。Expanding：实例扩容中。ExpandError：实例扩容失败。Deleting：实例删除中。DeleteError：实例删除失败。Stopped：实例已关停。Error：实例处于错误状态。
stopServiceTime String: 文件系统关停时间。
storeType String: 文件系统规格，取值说明如下：Advance100：100MB/s/TiB。Performance：性能版。IntelligentComputing：智算版。
storeTypeCn String: 文件系统规格中文名称，支持如下：100MB/s/TiB。性能版。智算版。
storeTypeEn String: 存储类型英文名。
subnetId String: 子网 ID。子网必须属于所选的可用区。
tags List<Property Map>: 标签列表。
updatedTime String: 文件系统更新时间。
versionNumber String: 文件系统版本号。
vpcId String: 私有网络 ID。
writeBandwidth Number: 写带宽值, 单位MB/s。
zoneId String: 可用区 ID。
zoneName String: 可用区名称。

Supporting Types

GetInstanceCapacityInfo

TotalTiB int: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
UsedGiB int: 已使用容量（GiB）。

TotalTiB int: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
UsedGiB int: 已使用容量（GiB）。

totalTiB Integer: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
usedGiB Integer: 已使用容量（GiB）。

totalTiB number: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
usedGiB number: 已使用容量（GiB）。

total_ti_b int: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
used_gi_b int: 已使用容量（GiB）。

totalTiB Number: 文件系统总容量，单位为 TiB。注意：磁盘均衡耗时会根据集群容量、集群负载等因素有所不同，如 PiB 级以上的集群扩容通常需要天级别的磁盘均衡时间，磁盘均衡完成后扩容容量才会生效（并为扩容容量计费）。
usedGiB Number: 已使用容量（GiB）。

GetInstanceTag

Key string: 用户标签的标签键。
Type string: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
Value string: 用户标签的标签值。

Key string: 用户标签的标签键。
Type string: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
Value string: 用户标签的标签值。

key String: 用户标签的标签键。
type String: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
value String: 用户标签的标签值。

key string: 用户标签的标签键。
type string: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
value string: 用户标签的标签值。

key str: 用户标签的标签键。
type str: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
value str: 用户标签的标签值。

key String: 用户标签的标签键。
type String: 标签类型，说明如下：Custom: 用户自定义标签。System: 系统标签。
value String: 用户标签的标签值。

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.vepfs.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceCapacityInfo

GetInstanceTag

Package Details

On this page

On this page