1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. filenas
  6. getInstance
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::FileNAS::Instance

    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:filenas/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:

    CachePerformance Volcengine.GetInstanceCachePerformance
    Cache performance information
    Capacity Volcengine.GetInstanceCapacity
    File system capacity
    ChargeType string
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    CreateTime string
    Creation time
    Description string
    Description
    FileSystemId string
    File system ID
    FileSystemName string
    File system name
    FileSystemType string
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project, default value is the Default project
    ProtocolType string
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    SnapshotCount int
    Number of snapshots
    SnapshotId string
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    Status string
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    StorageType string
    Storage type. Value: Standard, indicates standard type
    Tags List<Volcengine.GetInstanceTag>
    File system tag information
    UpdateTime string
    Update time
    ZoneId string
    Availability Zone ID
    ZoneName string
    Availability Zone name
    CachePerformance GetInstanceCachePerformance
    Cache performance information
    Capacity GetInstanceCapacity
    File system capacity
    ChargeType string
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    CreateTime string
    Creation time
    Description string
    Description
    FileSystemId string
    File system ID
    FileSystemName string
    File system name
    FileSystemType string
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    Id string
    Uniquely identifies the resource.
    ProjectName string
    Project, default value is the Default project
    ProtocolType string
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    SnapshotCount int
    Number of snapshots
    SnapshotId string
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    Status string
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    StorageType string
    Storage type. Value: Standard, indicates standard type
    Tags []GetInstanceTag
    File system tag information
    UpdateTime string
    Update time
    ZoneId string
    Availability Zone ID
    ZoneName string
    Availability Zone name
    cachePerformance GetInstanceCachePerformance
    Cache performance information
    capacity GetInstanceCapacity
    File system capacity
    chargeType String
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    createTime String
    Creation time
    description String
    Description
    fileSystemId String
    File system ID
    fileSystemName String
    File system name
    fileSystemType String
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    id String
    Uniquely identifies the resource.
    projectName String
    Project, default value is the Default project
    protocolType String
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    snapshotCount Integer
    Number of snapshots
    snapshotId String
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    status String
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    storageType String
    Storage type. Value: Standard, indicates standard type
    tags List<GetInstanceTag>
    File system tag information
    updateTime String
    Update time
    zoneId String
    Availability Zone ID
    zoneName String
    Availability Zone name
    cachePerformance GetInstanceCachePerformance
    Cache performance information
    capacity GetInstanceCapacity
    File system capacity
    chargeType string
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    createTime string
    Creation time
    description string
    Description
    fileSystemId string
    File system ID
    fileSystemName string
    File system name
    fileSystemType string
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    id string
    Uniquely identifies the resource.
    projectName string
    Project, default value is the Default project
    protocolType string
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    snapshotCount number
    Number of snapshots
    snapshotId string
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    status string
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    storageType string
    Storage type. Value: Standard, indicates standard type
    tags GetInstanceTag[]
    File system tag information
    updateTime string
    Update time
    zoneId string
    Availability Zone ID
    zoneName string
    Availability Zone name
    cache_performance GetInstanceCachePerformance
    Cache performance information
    capacity GetInstanceCapacity
    File system capacity
    charge_type str
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    create_time str
    Creation time
    description str
    Description
    file_system_id str
    File system ID
    file_system_name str
    File system name
    file_system_type str
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    id str
    Uniquely identifies the resource.
    project_name str
    Project, default value is the Default project
    protocol_type str
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    snapshot_count int
    Number of snapshots
    snapshot_id str
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    status str
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    storage_type str
    Storage type. Value: Standard, indicates standard type
    tags Sequence[GetInstanceTag]
    File system tag information
    update_time str
    Update time
    zone_id str
    Availability Zone ID
    zone_name str
    Availability Zone name
    cachePerformance Property Map
    Cache performance information
    capacity Property Map
    File system capacity
    chargeType String
    Billing type. Value: PayAsYouGo, indicates pay-as-you-go billing
    createTime String
    Creation time
    description String
    Description
    fileSystemId String
    File system ID
    fileSystemName String
    File system name
    fileSystemType String
    File system type. Possible values: Extreme: NAS Extreme type; Capacity: NAS Capacity type; Cache: NAS Cache type
    id String
    Uniquely identifies the resource.
    projectName String
    Project, default value is the Default project
    protocolType String
    File system protocol type. Value: NFS, indicates NFS protocol, commonly used for Linux clients
    snapshotCount Number
    Number of snapshots
    snapshotId String
    Snapshot ID used at creation. If this parameter is provided, the file system will be created from the snapshot
    status String
    File system status. Possible values: Unknown: Status unknown. Running: File system running. Creating: File system being created. Expanding: File system being upgraded. Error: File system error. Deleting: File system being deleted. DeleteError: File system deletion failed. Deleted: File system deleted. Stopped: File system stopped.
    storageType String
    Storage type. Value: Standard, indicates standard type
    tags List<Property Map>
    File system tag information
    updateTime String
    Update time
    zoneId String
    Availability Zone ID
    zoneName String
    Availability Zone name

    Supporting Types

    GetInstanceCachePerformance

    CacheBandwidth int
    Provisioned bandwidth, used to increase file system bandwidth
    CacheBandwidth int
    Provisioned bandwidth, used to increase file system bandwidth
    cacheBandwidth Integer
    Provisioned bandwidth, used to increase file system bandwidth
    cacheBandwidth number
    Provisioned bandwidth, used to increase file system bandwidth
    cache_bandwidth int
    Provisioned bandwidth, used to increase file system bandwidth
    cacheBandwidth Number
    Provisioned bandwidth, used to increase file system bandwidth

    GetInstanceCapacity

    Total double
    Total available file system capacity, in GiB
    Used double
    Used file system capacity, in MiB
    Total float64
    Total available file system capacity, in GiB
    Used float64
    Used file system capacity, in MiB
    total Double
    Total available file system capacity, in GiB
    used Double
    Used file system capacity, in MiB
    total number
    Total available file system capacity, in GiB
    used number
    Used file system capacity, in MiB
    total float
    Total available file system capacity, in GiB
    used float
    Used file system capacity, in MiB
    total Number
    Total available file system capacity, in GiB
    used Number
    Used file system capacity, in MiB

    GetInstanceTag

    Key string
    Tag key
    Type string
    Tag type
    Value string
    Tag value
    Key string
    Tag key
    Type string
    Tag type
    Value string
    Tag value
    key String
    Tag key
    type String
    Tag type
    value String
    Tag value
    key string
    Tag key
    type string
    Tag type
    value string
    Tag value
    key str
    Tag key
    type str
    Tag type
    value str
    Tag value
    key String
    Tag key
    type String
    Tag type
    value String
    Tag value

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.