DATASOURCE::NAS::FileSystems is used to query the details of file systems.

Syntax

{
  "Type": "DATASOURCE::NAS::FileSystems",
  "Properties": {
    "FileSystemType": String,
    "FileSystemId": String
  }
}

Properties

Property Type Required Editable Description Constraint
FileSystemType String No Yes The type of the file system. Default value: all. Valid values:
  • all: all types of file systems
  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
  • cpfs: Cloud Paralleled File System (CPFS) file system
FileSystemId String No Yes The ID of the file system. None.

Return values (Fn::GetAtt)

  • FileSystemIds: the IDs of the file systems.
  • FileSystems: details of the file systems.
Property Type Description Constraint
FileSystemIds List The IDs of the file systems. None.
FileSystems List Details of the file systems. None.
Status String The state of the file system. Valid values:
  • Pending: An operation on the file system is in progress.
  • Running: The file system is running.
    Note Before you perform subsequent operations, such as creating mount targets, you must make sure that the file system is in the Running state.
  • Stopped: The file system is unavailable.
  • Extending: The file system is being scaled up.
  • Stopping: The file system is being disabled.
  • Deleting: The file system is being deleted.
MeteredIASize String The storage usage of the Infrequent Access (IA) storage medium. Unit: bytes.
Capacity String The capacity of the file system. Unit: GiB.
CreateTime String The time when the file system was created. Example: 2017-05-27T15:43:06CST.
ChargeType String The type of the billing method. Valid values:
  • Subscription: subscription
  • PayAsYouGo: pay-as-you-go
  • Package: storage plan
Tags List The tags of the file system. None.
StorageType String The storage type. Valid values:
  • Valid values if the FileSystemType property is set to standard:
    • Capacity
    • Performance
  • Valid values if the FileSystemType property is set to extreme:
    • standard
    • advance
  • Valid values if the FileSystemType property is set to cpfs:
    • advance_100: 100 MB/s/TiB baseline
    • advance_200: 200 MB/s/TiB baseline
MeteredSize String The maximum storage usage of the file system within the previous hour.

Unit: bytes.

Description String The description of the file system. None.
Bandwidth String The bandwidth of the file system. Unit: MB/s.

This property is returned if the FileSystemType property is set to all, extreme, or cpfs.

SupportedFeatures List The features that are supported by the file system. Valid values:
  • Lifecycle: lifecycle management
  • ACL: access control list (ACL)
  • Ipv6: IPv6
    Note The IPv6 feature is supported if the FileSystemType property is set to extreme.
Version String The version of the file system. This property is returned when the FileSystemType property is set to extreme.
ProtocolType String The protocol type of the file system. Valid values:
  • NFS
  • SMB
  • cpfs
MountTargets List The mount targets. None.
KMSKeyId String The ID of the key that is managed by Key Management Service (KMS). None.
FileSystemType String The type of the file system. Valid values:
  • standard: General-purpose NAS file system
  • extreme: Extreme NAS file system
  • cpfs: CPFS file system
FileSystemId String The ID of the file system. None.
EncryptType Number The encryption type. Valid values:
  • 0: The file system is not encrypted.
  • 1: The file system is encrypted by using NAS-managed keys.
  • 2: The file system is encrypted by using user-managed keys.
Ldap List The configurations of Lightweight Directory Access Protocol (LDAP). This property is required if the FileSystemType property is set to cpfs.
ExpiredTime String The time when the file system expires. Example: 2017-08-27T15:43:06CST.
ZoneId String The ID of the zone in which the file system is deployed. None.
Packages List The storage plans. None.

Examples

  • JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "FileSystemId": {
      "Type": "String"
    }
  },
  "Resources": {
    "FileSystems": {
      "Type": "DATASOURCE::NAS::FileSystems",
      "Properties": {
        "FileSystemId": {
          "Ref": "FileSystemId"
        }
      }
    }
  },
  "Outputs": {
    "FileSystems": {
      "Description": "The list of file systems.",
      "Value": {
        "Fn::GetAtt": [
          "FileSystems",
          "FileSystems"
        ]
      }
    },
    "FileSystemIds": {
      "Description": "The list of file system IDs.",
      "Value": {
        "Fn::GetAtt": [
          "FileSystems",
          "FileSystemIds"
        ]
      }
    }
  }
}

  • YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  FileSystemId:
    Type: String
Resources:
  FileSystems:
    Type: DATASOURCE::NAS::FileSystems
    Properties:
      FileSystemId:
        Ref: FileSystemId
Outputs:
  FileSystems:
    Description: The list of file systems.
    Value:
      Fn::GetAtt:
        - FileSystems
        - FileSystems
  FileSystemIds:
    Description: The list of file system IDs.
    Value:
      Fn::GetAtt:
        - FileSystems
        - FileSystemIds