すべてのプロダクト
Search

このプロダクト

    File Storage NAS:DescribeFileSystems

    ドキュメントセンター

    File Storage NAS:DescribeFileSystems

    最終更新日:Jul 08, 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

    任意

    仮想非公開クラウド (VPC) の ID。

    VPC は、ファイルシステムをマウントする Elastic Computing Service (ECS) サービスの VPC と同じである必要があります。

    vpc-bp1sevsgtqvk5gxbl****
    PageSize

    integer

    任意

    ページングクエリ時の各ページに表示されるファイルシステムの数。

    有効な値: 1～100。

    デフォルト値: 10。

    1
    PageNumber

    integer

    任意

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

    開始値 (デフォルト値): 1。

    1
    StorageType

    string

    任意

    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>

    Status

    string

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

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

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

    • Stopped: ファイルシステムが利用できません。

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

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

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

    Pending
    MeteredIASize

    integer

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

    単位: バイト。

    362832
    Capacity

    integer

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

    単位: GiB。

    100
    CreateTime

    string

    ファイルシステムの作成時間。

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

    string

    課金方法。

    有効な値:

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

    • PayAsYouGo: 従量課金。

    • Package: ストレージプランが適用されています。

    PayAsYouGo
    Tags

    object

    Tag

    array<object>

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

    object

    Key

    string

    タグキー。

    testKey
    Value

    string

    タグ値。

    testValue
    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 ベースライン)

    Performance
    MeteredSize

    integer

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

    これはリアルタイムの値ではありません。過去 1 時間における最大値を表します。単位: バイト。

    説明

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

    1611661312
    Description

    string

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

    test
    Bandwidth

    integer

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

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

    150
    SupportedFeatures

    object

    SupportedFeature

    array

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

    string

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

    有効な値:

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

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

    • Ipv6: IPv6。

    説明

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

    Lifecycle
    Version

    string

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

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

    2.3.4
    ProtocolType

    string

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

    有効な値:

    • NFS: NFS プロトコル。

    • SMB: SMB プロトコル。

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

    NFS
    MountTargets

    object

    MountTarget

    array<object>

    マウントポイント情報。

    array<object>

    VpcId

    string

    VPC の ID。

    vpc-bp1sevsgtqvk5gxbl****
    Status

    string

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

    有効な値:

    • Active: アクティブな状態。

    • Inactive: 利用不可。

    • Pending: タスクを処理中。

    • Deleting: 削除中。

    • Hibernating: 休止状態に移行中。

    • Hibernated: 休止状態。

    Active
    ClientMasterNodes

    object

    ClientMasterNode

    array<object>

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

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

    object

    EcsId

    string

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

    i-hp3i3odi5ory1buo****
    DefaultPasswd

    string

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

    123456
    EcsIp

    string

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

    192.168.1.0
    MountTargetDomain

    string

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

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

    string

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

    test-001
    DualStackMountTargetDomain

    string

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

    説明

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

    174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
    VswId

    string

    vSwitch の ID。

    vsw-bp1omfzsszekkvaxn****
    Tags

    object

    Tag

    array<object>

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

    object

    Key

    string

    タグキー。

    testKey
    Value

    string

    タグ値。

    testValue
    NetworkType

    string

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

    vpc
    KMSKeyId

    string

    KMS キーの ID。

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

    string

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

    sp-extreme-09npwxadu1eqvw****
    RegionId

    string

    リージョン ID。

    cn-hangzhou
    FileSystemType

    string

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

    有効な値:

    • standard: 汎用 NAS。

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

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

    • cpfsse: CPFS SE、ゾーン冗長。

    standard
    FileSystemId

    string

    ファイルシステムの ID。

    109c04****
    EncryptType

    integer

    暗号化タイプ。

    有効な値:

    • 0: 暗号化なし。

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

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

    1
    Ldap

    object

    LDAP 構成情報。

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

    BindDN

    string

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

    cn=alibaba,dc=com
    SearchBase

    string

    LDAP 検索ベース。

    dc=example
    URI

    string

    LDAP サーバーのアドレス。

    ldap://ldap.example.example
    ExpiredTime

    string

    ファイルシステムの有効期限時間。

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

    string

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

    cn-hangzhou-b
    VpcId

    string

    VPC の ID。

    vpc-bp1sevsgtqvk5gxbl****

    VswIds

    object

    VswId

    array

    vSwitch 情報。

    string

    vSwitch の ID。

    vsw-bp1omfzsszekkvaxn****

    Packages

    object

    Package

    array<object>

    ストレージプラン情報。

    object

    StartTime

    string

    ストレージプランの開始時刻。

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

    string

    ストレージプランの有効期限時間。

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

    integer

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

    107374182400
    PackageId

    string

    ストレージプランの ID。

    naspackage-0be9c4b624-37****
    PackageType

    string

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

    有効な値:

    • ssd: Performance。

    • hybrid: Capacity。

    hybrid
    AccessPointCount

    string

    アクセスポイントの数。

    1
    ResourceGroupId

    string

    リソースグループの ID。

    rg-acfmwavnfef****

    MeteredArchiveSize

    integer

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

    単位: バイト。

    1611661312
    Options

    object

    オプション。

    EnableOplock

    boolean

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

    • true: 有効。

    • false: 無効。

    説明

    この特徴をサポートするのは、SMB プロトコルの種類を使用するファイルシステムのみです。

    true
    VscAccessPointAccessOnly

    boolean

    EnableABE

    boolean

    QuorumVswId

    string

    vSwitch の ID。

    vsw-bp1omfzsszekkvaxn****
    VscTarget

    string
    説明

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

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

    string

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

    LRS
    RedundancyVSwitchIds

    object

    RedundancyVSwitchId

    array

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

    string

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

    vsw-123xxx
    RequestId

    string

    リクエスト ID。

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

    integer

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

    1
    PageSize

    integer

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

    1
    PageNumber

    integer

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

    1

    例

    成功レスポンス

    JSONJSON

    {
  "FileSystems": {
    "FileSystem": [
      {
        "Status": "Pending",
        "MeteredIASize": 362832,
        "Capacity": 100,
        "CreateTime": "2020-01-05T16:00:00Z",
        "ChargeType": "PayAsYouGo",
        "Tags": {
          "Tag": [
            {
              "Key": "testKey",
              "Value": "testValue"
            }
          ]
        },
        "StorageType": "Performance",
        "MeteredSize": 1611661312,
        "Description": "test",
        "Bandwidth": 150,
        "SupportedFeatures": {
          "SupportedFeature": [
            "Lifecycle"
          ]
        },
        "Version": "2.3.4",
        "ProtocolType": "NFS",
        "MountTargets": {
          "MountTarget": [
            {
              "VpcId": "vpc-bp1sevsgtqvk5gxbl****",
              "Status": "Active",
              "ClientMasterNodes": {
                "ClientMasterNode": [
                  {
                    "EcsId": "i-hp3i3odi5ory1buo****",
                    "DefaultPasswd": "123456",
                    "EcsIp": "192.168.1.0"
                  }
                ]
              },
              "MountTargetDomain": "109c042666-w****.cn-hangzhou.nas.aliyuncs.com",
              "AccessGroupName": "test-001",
              "DualStackMountTargetDomain": "174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com",
              "VswId": "vsw-bp1omfzsszekkvaxn****",
              "Tags": {
                "Tag": [
                  {
                    "Key": "testKey",
                    "Value": "testValue"
                  }
                ]
              },
              "NetworkType": "vpc"
            }
          ]
        },
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "AutoSnapshotPolicyId": "sp-extreme-09npwxadu1eqvw****",
        "RegionId": "cn-hangzhou",
        "FileSystemType": "standard",
        "FileSystemId": "109c04****",
        "EncryptType": 1,
        "Ldap": {
          "BindDN": "cn=alibaba,dc=com",
          "SearchBase": "dc=example",
          "URI": "ldap://ldap.example.example"
        },
        "ExpiredTime": "2020-01-05T16:00:00Z",
        "ZoneId": "cn-hangzhou-b",
        "VpcId": "vpc-bp1sevsgtqvk5gxbl****\n",
        "VswIds": {
          "VswId": [
            "vsw-bp1omfzsszekkvaxn****\n"
          ]
        },
        "Packages": {
          "Package": [
            {
              "StartTime": "2019-12-05T01:40:56Z",
              "ExpiredTime": "2020-01-05T16:00:00Z",
              "Size": 107374182400,
              "PackageId": "naspackage-0be9c4b624-37****",
              "PackageType": "hybrid"
            }
          ]
        },
        "AccessPointCount": "1",
        "ResourceGroupId": "rg-acfmwavnfef****\n",
        "MeteredArchiveSize": 1611661312,
        "Options": {
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false,
          "EnableABE": false
        },
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "RedundancyType": "LRS",
        "RedundancyVSwitchIds": {
          "RedundancyVSwitchId": [
            "vsw-123xxx"
          ]
        }
      }
    ]
  },
  "RequestId": "035B3A3A-E514-4B41-B906-5D906CFB****",
  "TotalCount": 1,
  "PageSize": 1,
  "PageNumber": 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. 指定されたファイルシステムが存在しません。

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

    変更履歴

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