DescribeFileSystems - File Storage NAS - Alibaba Cloud ドキュメントセンター

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

今すぐお試しください

この 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)。 CPFS (ローカル冗長): cpfs- で始まる必要があります (例: cpfs-125487)。 CPFS SE (ゾーン冗長): cpfsse- で始まる必要があります (例: cpfsse-022c71b134**)。	31a8e4****
FileSystemType	string	任意	ファイルシステムのタイプ。有効な値: all (デフォルト): すべてのタイプを照会します。 standard: 汎用 NAS。 extreme: エクストリーム NAS。 cpfs: ローカル冗長ストレージを備えた Cloud Parallel File Storage (CPFS)。 cpfsse: ゾーン冗長ストレージを備えた Cloud Parallel File Storage (CPFS) SE。説明複数のタイプを照会するには、カンマ (,) で区切ります。	standard
VpcId	string	任意	VPC の ID。	vpc-bp1sevsgtqvk5gxbl****
PageSize	integer	任意	ページングクエリにおける各ページのファイルシステム数。	1
PageNumber	integer	任意	ファイルシステムリストのページ番号。	1
StorageType	string	任意	ストレージタイプ。現在、フィルタークエリでサポートされているのは Lingjun 仕様の CPFS のみです。他の FileSystemType 値はサポートされていません。以下の仕様がサポートされています: 列挙値: standard : standard。 Agentic : AgenticFS。 Capacity : capacity。 advance_200 : 200 MB/s/TiB ベースライン。 advance_100 : 100 MB/s/TiB ベースライン。 Premium : premium。 Performance : performance。 economic : economy。 advance : advanced。	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>
Status	string	ファイルシステムのステータス。有効な値:	Pending
MeteredIASize	integer	IA ストレージクラスの使用量。	362832
Capacity	integer	ファイルシステムの容量。	100
CreateTime	string	ファイルシステムが作成された時間。時間は yyyy-MM-ddTHH:mm:ssCST フォーマットの CST ローカルタイムゾーンで表示されます。例: 2026-07-20T14:31:42CST。	2026-07-20T14:31:42CST
ChargeType	string	課金方法。有効な値: Subscription: サブスクリプション。 PayAsYouGo: 従量課金。 Package: ストレージプランが適用されています。	PayAsYouGo
Tags	object
Tag	array<object>	ファイルシステムのタグのコレクション。
	object
Key	string	タグキー。	testKey
Value	string	タグ値。	testValue
StorageType	string	ストレージタイプ。	Performance
MeteredSize	integer	ファイルシステムの標準ストレージ使用量。これはリアルタイムの使用量ではありません。この値は、過去 1 時間における最大使用量を示します。単位: バイト。説明ファイルシステムの合計ストレージ容量を確認するには、「ファイルシステムのリソース使用量の照会」を参照してください。	1611661312
Description	string	ファイルシステムの説明。	test
Bandwidth	integer	ファイルシステムの帯域幅。	150
SupportedFeatures	object
SupportedFeature	array	ファイルシステムがサポートする特徴のコレクション。
	string	ファイルシステムがサポートする機能。有効な値: Lifecycle: ライフサイクル管理。 ACL: アクセス制御リスト。 Ipv6: IPv6。説明現在、IPv6 をサポートしているのは、中国本土のリージョンにあるエクストリーム NAS ファイルシステムのみです。	Lifecycle
Version	string	ファイルシステムのバージョン番号。	2.3.4
ProtocolType	string	ファイルシステムのプロトコルの種類。	NFS
MountTargets	object
MountTarget	array<object>	マウントポイント情報のコレクション。フォーマット。
	array<object>
VpcId	string	マウントポイントに関連付けられた VPC の ID。このフィールドは汎用 NAS ファイルシステムに対してのみ返されます。	vpc-bp1sevsgtqvk5gxbl****
Status	string	マウントポイントのステータス。	Active
ClientMasterNodes	object
ClientMasterNode	array<object>	クライアント管理ノード情報のコレクション。フォーマット。
	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) マウントポイントのドメイン。	174494b666-x****.dualstack.cn-hangzhou.nas.aliyuncs.com
VswId	string	マウントポイントに関連付けられた vSwitch の ID。このフィールドは汎用 NAS ファイルシステムに対してのみ返されます。	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 (ローカル冗長)。 cpfsse: Cloud Parallel File Storage SE (ゾーン冗長)。	standard
FileSystemId	string	ファイルシステムの ID。	109c04****
EncryptType	integer	暗号化タイプ。	1
Ldap	object	LDAP 構成情報。フォーマット。
BindDN	string	LDAP サーバーへのバインドに使用される識別名 (DN)。	cn=alibaba,dc=com
SearchBase	string	LDAP 検索ベース。	dc=example
URI	string	LDAP サーバーアドレス。	ldap://ldap.example.example
ExpiredTime	string	ファイルシステムの有効期限。時間は ISO 8601 標準に基づき、yyyy-MM-ddTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2020-01-05T16:00:00Z
ZoneId	string	ファイルシステムが存在するゾーン。	cn-hangzhou-b
VpcId	string	ファイルシステムに関連付けられた VPC の ID。このフィールドは汎用 CPFS ファイルシステムに対してのみ返されます。	vpc-bp1sevsgtqvk5gxbl****
VswIds	object
VswId	array	vSwitch 情報のコレクション。フォーマット。
	string	ファイルシステムに関連付けられた vSwitch の ID。このフィールドは汎用 CPFS ファイルシステムに対してのみ返されます。	vsw-2zeu1ncsckw5mv2j481gw
Packages	object
Package	array<object>	ストレージプラン情報のコレクション。フォーマット。
	object
StartTime	string	ストレージプランの開始時刻。時間は ISO 8601 標準に基づき、yyyy-MM-ddTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2019-12-05T01:40:56Z
ExpiredTime	string	ストレージプランの有効期限。時間は ISO 8601 標準に基づき、yyyy-MM-ddTHH:mm:ssZ フォーマットの協定世界時 (UTC) で表示されます。	2020-01-05T16:00:00Z
Size	integer	ストレージプランの容量。	107374182400
PackageId	string	ストレージプラン ID。	naspackage-0be9c4b624-37****
PackageType	string	ストレージプランタイプ。	hybrid
AccessPointCount	string	アクセスポイントの数。	1
ResourceGroupId	string	リソースグループの ID。	rg-acfmwavnfef****
MeteredArchiveSize	integer	アーカイブストレージの使用量。	1611661312
Options	object	オプション。
EnableOplock	boolean	OpLock 機能が有効かどうかを示します。有効な値: true: 有効です。 false: 無効です。説明 SMB ファイルシステムのみがサポートされています。	true
VscAccessPointAccessOnly	boolean	VSC マウントポイントがアクセスポイント経由のアクセスのみをサポートするかどうかを示します。	false
EnableABE	boolean	SMB アクセスベースの列挙 (ABE) アクセスのコントロール特徴が有効かどうかを示します。	true
EnableDataInsight	boolean	EBS レンズの特徴が有効かどうかを示します。	false
QuorumVswId	string	vSwitch の ID。	vsw-bp1omfzsszekkvaxn****
VscTarget	string	説明このパラメーターは使用できません。	cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com
RedundancyType	string	ストレージの冗長性タイプ。このフィールドには CPFS SE ファイルシステムの場合のみ値があります。	ZRS
RedundancyVSwitchIds	object
RedundancyVSwitchId	array	ゾーン冗長 vSwitch ID のリスト。
	string	ゾーン冗長 vSwitch ID のリスト。	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": "2026-07-20T14:31:42CST",
        "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****",
        "VswIds": {
          "VswId": [
            "vsw-2zeu1ncsckw5mv2j481gw"
          ]
        },
        "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****",
        "MeteredArchiveSize": 1611661312,
        "Options": {
          "EnableOplock": true,
          "VscAccessPointAccessOnly": false,
          "EnableABE": true,
          "EnableDataInsight": false
        },
        "QuorumVswId": "vsw-bp1omfzsszekkvaxn****",
        "VscTarget": "cpfs-370y1tv921vpuj4****-000001.cn-wulanchabu.cpfs.aliyuncs.com",
        "RedundancyType": "ZRS",
        "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.	指定されたファイルシステムが存在しません。

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

変更履歴

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