すべてのプロダクト
Search

このプロダクト

    File Storage NAS:DescribeFileSystems

    ドキュメントセンター

    File Storage NAS:DescribeFileSystems

    最終更新日:Sep 21, 2026

    ファイルシステム情報を照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    nas:DescribeFileSystems

    get

    *FileSystem

    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileSystemId

    string

    任意

    ファイルシステム ID。

    • 汎用 NAS: 31a8e4****。

    • エクストリーム NAS: extreme- で始まる必要があります (例: extreme-0015****)。

    • Cloud Parallel File Storage (CPFS) (ローカル冗長バージョン): cpfs- で始まる必要があります (例: cpfs-125487****)。

    • CPFS SE (ゾーン冗長バージョン): cpfsse- で始まる必要があります (例: cpfsse-022c71b134****)。

    31a8e4****
    FileSystemType

    string

    任意

    ファイルシステムタイプ。

    有効な値:

    • all (デフォルト): すべてのタイプを照会します。

    • standard: 汎用 NAS。

    • extreme: エクストリーム NAS。

    • cpfs: Cloud Parallel File Storage (CPFS) (ローカル冗長バージョン)。

    • cpfsse: CPFS SE (ゾーン冗長バージョン)。

    説明

    複数のタイプを照会するには、カンマ (,) で区切ります。

    standard
    VpcId

    string

    任意

    Virtual Private Cloud (VPC) ID。

    VPC は、ファイルシステムをマウントするエラスティックコンピューティングサービス (ECS) サーバーの VPC と同じである必要があります。

    vpc-bp1sevsgtqvk5gxbl****
    PageSize

    integer

    任意

    ページングクエリ時の各ページのファイルシステム数。

    有効な値: 1～100。

    デフォルト値: 10。

    1
    PageNumber

    integer

    任意

    ファイルシステムリストのページ番号。

    デフォルト値: 1。

    1
    StorageType

    string

    任意

    ストレージタイプ。現在、フィルタークエリでは Lingjun 仕様の CPFS のみがサポートされています。他のファイルシステムタイプ (FileSystemType) はサポートされていません。以下の仕様（ステップサイズなど）がサポートされています。

    • bm_advance_400

    • bm_advance_400_large

    • bm_advance_new

    • bm_advance_100

    • cpfslight_100

    • bm_p100_stepsize_300

    • bm_p400_stepsize_1

    • bm_p400_stepsize_300

    カンマ (,) で区切って複数の仕様を指定できます。例: bm_advance_400,bm_advance_new。

    bm_advance_400
    Tag

    array<object>

    任意

    タグ情報。

    object

    任意

    タグ情報。

    Key

    string

    任意

    タグキー。

    使用制限:

    • N の有効な値: 1～20。

    • タグキーの長さは最大 128 文字です。

    • タグキーの先頭を aliyun または acs: にすることはできません。

    • タグキーに http:// または https:// を含めることはできません。

    testKey
    Value

    string

    任意

    タグ値。

    使用制限:

    • N の有効な値: 1～20。

    • タグ値の長さは最大 128 文字です。

    • タグ値の先頭を aliyun または acs: にすることはできません。

    • タグ値に http:// または https:// を含めることはできません。

    testValue
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    リソースグループ ID は、リソース管理コンソール で確認できます。

    rg-acfmwavnfef****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    FileSystems

    object

    FileSystem

    array<object>

    ファイルシステムのリスト。

    array<object>

    AccessPointCount

    string

    アクセスポイントの数。

    1
    AutoSnapshotPolicyId

    string

    自動スナップショットポリシーの ID。

    sp-extreme-09npwxadu1eqvw****
    AutoUpgradeConfig

    object

    自動拡張構成。

    capacityUsedRatio

    integer

    使用量のしきい値 (パーセント)。

    80
    enabled

    boolean

    自動拡張を有効にするかどうかを指定します。有効な値:

    • true: 自動拡張を有効にします。

    • false: 自動拡張を無効にします。

    step

    integer

    拡張のステップサイズ。単位: GiB。

    100
    time

    integer

    持続時間のしきい値。単位: 分。

    30
    Bandwidth

    integer

    ファイルシステムの帯域幅。

    単位: MB/s。汎用 NAS ファイルシステムの場合、このフィールドは返されません。

    150
    Capacity

    integer

    ファイルシステムの容量。

    単位: GiB。

    100
    ChargeType

    string

    課金タイプ。

    有効な値:

    • Subscription: サブスクリプション。

    • PayAsYouGo: 従量課金。

    • Package: ストレージプランがバインドされている。

    PayAsYouGo
    CreateTime

    string

    ファイルシステムが作成された時間。時間は CST ローカルタイムゾーンで yyyy-MM-ddTHH:mm:ssCST のフォーマットで表示されます。例: 2026-07-20T14:31:42CST。

    2026-07-20T14:31:42CST
    Description

    string

    ファイルシステムの説明。

    test
    EncryptType

    integer

    暗号化タイプ。

    有効な値:

    • 0: 暗号化なし。

    • 1: NAS マネージドキー。

    • 2: カスタムキー (KMS)。

    1
    ExpiredTime

    string

    ファイルシステムが有効期限を迎える時間。時間は ISO 8601 標準の協定世界時 (UTC) で表されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。

    2020-01-05T16:00:00Z
    FileSystemId

    string

    ファイルシステム ID。

    109c04****
    FileSystemType

    string

    ファイルシステムタイプ。

    有効な値:

    • standard: 汎用 NAS。

    • extreme: エクストリーム NAS。

    • cpfs: Cloud Parallel File Storage (CPFS) (ローカル冗長)。

    • cpfsse: CPFS SE (ゾーン冗長)。

    standard
    KMSKeyId

    string

    KMS キー ID。

    0e478b7a-4262-4802-b8cb-00d3fb40****
    Ldap

    object

    LDAP 構成情報。

    このパラメーターは CPFS ファイルシステムに対してのみ返されます。

    BindDN

    string

    LDAP サーバーへのバインドに使用される識別名 (DN)。

    cn=alibaba,dc=com
    SearchBase

    string

    LDAP 検索ベース。

    dc=example
    URI

    string

    LDAP サーバーアドレス。

    ldap://ldap.example.example
    MeteredArchiveSize

    integer

    アーカイブストレージクラスのストレージ使用量。

    単位: バイト。

    1611661312
    MeteredIASize

    integer

    IA ストレージクラスのストレージ使用量。

    単位: バイト。

    362832
    MeteredSize

    integer

    ファイルシステムの標準ストレージ使用量。

    これはリアルタイムの使用量ではありません。この値は、直近 1 時間の最大値を示します。単位: バイト。

    説明

    ファイルシステムの合計ストレージ容量を確認するには、「ファイルシステムのリソース使用量の照会」を参照してください。

    1611661312
    MountTargets

    object

    MountTarget

    array<object>

    マウントポイント情報。

    array<object>

    AccessGroupName

    string

    マウントポイントで使用される権限グループの名前。

    test-001
    ClientMasterNodes

    object

    ClientMasterNode

    array<object>

    クライアント管理ノード情報。

    このパラメーターは CPFS ファイルシステムに対してのみ返されます。

    object

    DefaultPasswd

    string

    管理ノードのデフォルトのログインパスワード。

    123456
    EcsId

    string

    管理ノードの ECS インスタンス ID。

    i-hp3i3odi5ory1buo****
    EcsIp

    string

    管理ノードの ECS インスタンスの IP アドレス。

    192.168.1.0
    DualStackMountTargetDomain

    string

    デュアルスタック (IPv4 および IPv6) マウントポイントドメイン。

    説明

    IPv6 は、中国本土のリージョンにあるエクストリーム NAS ファイルシステムでのみサポートされています。

    174494b666-x****.dualスタック.cn-hangzhou.nas.aliyuncs.com
    MountTargetDomain

    string

    マウントポイントドメイン。

    109c042666-w****.cn-hangzhou.nas.aliyuncs.com
    NetworkType

    string

    ネットワークタイプ。値 vpc は VPC を示します。

    vpc
    Status

    string

    マウントポイントのステータス。

    有効な値:

    • Active: アクティブな。

    • Inactive: 利用不可。

    • Pending: タスクが処理中。

    • Deleting: マウントポイントが削除中。

    • Hibernating: マウントポイントが休止状態に移行中。

    • Hibernated: マウントポイントが休止状態。

    Active
    Tags

    object

    Tag

    array<object>

    マウントポイントのタグ情報。

    object

    Key

    string

    タグキー。

    testKey
    Value

    string

    タグ値。

    testValue
    VpcId

    string

    マウントポイントに関連付けられた VPC ID。このフィールドは汎用 NAS ファイルシステムに対してのみ返されます。

    vpc-bp1sevsgtqvk5gxbl****
    VswId

    string

    マウントポイントに関連付けられた vSwitch ID。このフィールドは汎用 NAS ファイルシステムに対してのみ返されます。

    vsw-bp1omfzsszekkvaxn****
    Options

    object

    オプション。

    EnableABE

    boolean

    SMB アクセスベースの列挙 (ABE) アクセス制御機能が有効かどうかを示します。

    true
    EnableDataInsight

    boolean

    EBS レンズ機能が有効かどうかを示します。

    false
    EnableOplock

    boolean

    OpLock 機能が有効かどうかを示します。 有効な値:

    • true: 有効。

    • false: 無効。

    説明

    この機能は、SMB プロトコルタイプのファイルシステムでのみサポートされています。

    true
    VscAccessPointAccessOnly

    boolean

    AI コンピューティング用 VSC マウントポイントがアクセスポイント経由のアクセスのみをサポートするかどうかを示します。

    false
    Packages

    object

    Package

    array<object>

    ストレージプラン情報。

    object

    ExpiredTime

    string

    ストレージプランが有効期限を迎える時間。時間は ISO 8601 標準の協定世界時 (UTC) で表されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。

    2020-01-05T16:00:00Z
    PackageId

    string

    ストレージプラン ID。

    nasパッケージ-0be9c4b624-37****
    PackageType

    string

    ストレージプランタイプ。

    有効な値:

    • ssd: パフォーマンス NAS ファイルシステム。

    • hybrid: 容量 NAS ファイルシステム。

    hybrid
    Size

    integer

    ストレージプランの容量。 単位: バイト。

    107374182400
    StartTime

    string

    ストレージプランの開始時刻。時間は ISO 8601 標準の協定世界時 (UTC) で表されます。フォーマット: yyyy-MM-ddTHH:mm:ssZ。

    2019-12-05T01:40:56Z
    ProtocolType

    string

    ファイルシステムのプロトコルタイプ。

    有効な値:

    • NFS: NFS プロトコル。

    • SMB: SMB プロトコル。

    • cpfs: CPFS または CPFS SE ファイルシステムでサポートされるプロトコルタイプ。

    NFS
    QuorumVswId

    string

    vSwitch ID。

    vsw-bp1omfzsszekkvaxn****
    RedundancyType

    string

    ストレージの冗長性タイプ。このフィールドは CPFS SE ファイルシステムに対してのみ値を持ちます。

    ZRS
    RedundancyVSwitchIds

    object

    RedundancyVSwitchId

    array

    ゾーン冗長 vSwitch ID のリスト。

    string

    ゾーン冗長 vSwitch ID のリスト。 このフィールドは、RedundancyType が ZRS に設定されている場合に値を持ちます。

    vsw-123xxx
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    ResourceGroupId

    string

    リソースグループ ID。

    rg-acfmwavnfef****
    Status

    string

    ファイルシステムのステータス。有効な値:

    • Pending: ファイルシステムがノードを処理中。

    • Running: ファイルシステムがアクティブ。ステータスが Running の場合にのみ、次の操作 (マウントポイントの作成など) を実行できます。

    • Stopped: ファイルシステムが利用不可。

    • Extending: ファイルシステムがスケールアウト中。

    • Stopping: ファイルシステムが停止中。

    • Deleting: ファイルシステムが削除中。

    Pending
    StorageType

    string

    ストレージタイプ。

    有効な値:

    • 汎用 NAS: Capacity、Performance、または Premium

    • エクストリーム NAS: standard または advance

    • CPFS: advance_100 (100 MB/s/TiB ベースライン)、advance_200 (200 MB/s/TiB ベースライン)、または economic

    • CPFS SE: advance_100 (100 MB/s/TiB ベースライン)

    • AgenticFS: Agentic (FileSystemType が standard に設定されている場合にのみ利用可能)

    • CPFS for Lingjun: bm_advance_400、bm_advance_400_large、bm_advance_new、bm_advance_100、cpfslight_100、bm_p100_ステップサイズ_300、bm_p400_ステップサイズ_1、または bm_p400_ステップサイズ_300

    Performance
    SupportedFeatures

    object

    SupportedFeature

    array

    ファイルシステムでサポートされている特徴。

    string

    ファイルシステムでサポートされている特徴。

    有効な値:

    • Lifecycle: ライフサイクル管理。

    • ACL: アクセスコントロールリスト。

    • Ipv6: IPv6。

    説明

    現在、IPv6 は中国本土のリージョンにあるエクストリーム NAS ファイルシステムでのみサポートされています。

    Lifecycle
    Tags

    object

    Tag

    array<object>

    ファイルシステムのタグ情報。

    object

    Key

    string

    タグキー。

    testKey
    Value

    string

    タグ値。

    testValue
    Version

    string

    ファイルシステムのバージョン番号。

    このフィールドはエクストリーム NAS および CPFS ファイルシステムに適用されます。

    2.3.4
    VpcId

    string

    ファイルシステムに関連付けられた VPC ID。このフィールドは汎用 CPFS ファイルシステムに対してのみ返されます。

    vpc-bp1sevsgtqvk5gxbl****
    VscTarget

    string
    説明

    このパラメーターは使用できません。

    cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
    VswIds

    object

    VswId

    array

    vSwitch 情報。

    string

    ファイルシステムに関連付けられた vSwitch ID。このフィールドは汎用 CPFS ファイルシステムに対してのみ返されます。

    vsw-2zeu1ncsckw5mv2j481gw
    ZoneId

    string

    ファイルシステムが存在するゾーン。

    cn-hangzhou-b
    PageNumber

    integer

    ファイルシステムリストのページ番号。

    1
    PageSize

    integer

    各ページのファイルシステム数。

    1
    RequestId

    string

    リクエスト ID。

    035B3A3A-E514-4B41-B906-5D906CFB****
    TotalCount

    integer

    ファイルシステムの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "FileSystems": {
    "FileSystem": [
      {
        "AccessPointCount": "1",
        "AutoSnapshotPolicyId": "sp-extreme-09npwxadu1eqvw****",
        "AutoUpgradeConfig": {
          "capacityUsedRatio": 80,
          "enabled": false,
          "step": 100,
          "time": 30
        },
        "Bandwidth": 150,
        "Capacity": 100,
        "ChargeType": "PayAsYouGo",
        "CreateTime": "2026-07-20T14:31:42CST",
        "Description": "test",
        "EncryptType": 1,
        "ExpiredTime": "2020-01-05T16:00:00Z",
        "FileSystemId": "109c04****",
        "FileSystemType": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "Ldap": {
          "BindDN": "cn=alibaba,dc=com",
          "SearchBase": "dc=example",
          "URI": "ldap://ldap.example.example"
        },
        "MeteredArchiveSize": 1611661312,
        "MeteredIASize": 362832,
        "MeteredSize": 1611661312,
        "MountTargets": {
          "MountTarget": [
            {
              "AccessGroupName": "test-001",
              "ClientMasterNodes": {
                "ClientMasterNode": [
                  {
                    "DefaultPasswd": "123456",
                    "EcsId": "i-hp3i3odi5ory1buo****",
                    "EcsIp": "192.168.1.0"
                  }
                ]
              },
              "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
              "MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
              "NetworkType": "vpc",
              "Status": "Active",
              "Tags": {
                "Tag": [
                  {
                    "Key": "testKey",
                    "Value": "testValue"
                  }
                ]
              },
              "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
              "VswId": "vsw-bp1omfzsszekkvaxn****"
            }
          ]
        },
        "Options": {
          "EnableABE": true,
          "EnableDataInsight": false,
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false
        },
        "Packages": {
          "Package": [
            {
              "ExpiredTime": "2020-01-05T16:00:00Z",
              "PackageId": "naspackage-0be9c4b624-37****",
              "PackageType": "hybrid",
              "Size": 107374182400,
              "StartTime": "2019-12-05T01:40:56Z"
            }
          ]
        },
        "ProtocolType": "NFS",
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "RedundancyType": "ZRS",
        "RedundancyVSwitchIds": {
          "RedundancyVSwitchId": [
            "vsw-123xxx"
          ]
        },
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmwavnfef****",
        "Status": "Pending",
        "StorageType": "Performance",
        "SupportedFeatures": {
          "SupportedFeature": [
            "Lifecycle"
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "Version": "2.3.4",
        "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "VswIds": {
          "VswId": [
            "vsw-2zeu1ncsckw5mv2j481gw"
          ]
        },
        "ZoneId": "cn-hangzhou-b"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 1,
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "TotalCount": 1
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Region.NotSupported The specified Region is not supported for this API now. 現在のリージョンではこの特徴はサポートされていません。
    404 InvalidFileSystem.NotFound The specified file system does not exist. 指定されたファイルシステムが存在しません。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。