DATASOURCE::NAS::FileSystems

更新时间:
复制 MD 格式

Queries information about NAS file systems.

Syntax

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

Properties

Property

Type

Required

Editable

Description

Constraint

FileSystemType

String

No

Yes

The file system type.

Valid values:

  • all (default): all types of file systems

  • standard: General-purpose File Storage NAS (NAS) file system

  • extreme: Extreme NAS file system

  • cpfs: Cloud Parallel File Storage (CPFS) file system

FileSystemId

String

No

Yes

The file system ID.

None.

RefreshOptions

String

No

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

  • Never (default): Does not refresh data source resources when the stack is updated.

  • Always: Refreshes data source resources when the stack is updated.

Return values (Fn::GetAtt)

  • FileSystemIds: the file system IDs.

  • FileSystems: the file system details.

Property

Type

Description

Constraint

FileSystemIds

List

The file system IDs.

None.

FileSystems

List

The file system details.

None.

Status

String

The file system status.

Valid values:

  • Pending: The file system task is being processed.

  • Running: The file system is running.

    Note

    You can perform operations such as creating a mount target only when 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 stopped.

  • Deleting: The file system is being deleted.

MeteredIASize

String

The storage usage of the Infrequent Access (IA) storage class.

Unit: bytes.

Capacity

String

The file system capacity.

Unit: GiB.

CreateTime

String

The time when the file system was created.

Example: 2017-05-27T15:43:06CST.

ChargeType

String

The billing method.

Valid values:

  • Subscription: subscription

  • PayAsYouGo: pay-as-you-go

  • Package: storage plan

Tags

List

The file system tags.

None.

StorageType

String

The storage type.

  • Valid values when FileSystemType is set to standard:

    • Capacity

    • Performance

  • Valid values when FileSystemType is set to extreme:

    • standard

    • advance

  • Valid values when FileSystemType is set to cpfs:

    • advance_100: 100 MB/s/TiB baseline

    • advance_200: 200 MB/s/TiB baseline

MeteredSize

String

The peak storage usage of the file system in the previous hour.

Unit: bytes.

Description

String

The file system description.

None.

Bandwidth

String

The file system bandwidth.

Unit: MB/s.

Returned only when FileSystemType is set to all, extreme, or cpfs.

SupportedFeatures

List

The features supported by the file system.

Valid values:

  • Lifecycle: lifecycle management

  • ACL: access control list (ACL)

  • Ipv6: IPv6

    Note

    IPv6 is supported only when FileSystemType is set to extreme.

Version

String

The file system version.

Returned only when FileSystemType is set to extreme.

ProtocolType

String

The protocol type of the file system.

Valid values:

  • NFS

  • SMB

  • cpfs

MountTargets

List

The mount target information.

None.

KMSKeyId

String

The ID of the KMS key.

None.

FileSystemType

String

The file system type.

Valid values:

  • standard: General-purpose NAS file system

  • extreme: Extreme NAS file system

  • cpfs: CPFS file system

FileSystemId

String

The file system ID.

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 LDAP configurations.

Returned only when FileSystemType is set to cpfs.

ExpiredTime

String

The file system expiration time.

Example: 2017-08-27T15:43:06CST.

ZoneId

String

The zone ID of the file system.

None.

Packages

List

The storage plan information.

None.

Examples

{
  "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"
        ]
      }
    }
  }
}
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