ファイルシステムクエリ用の DescribeFileSystems API リファレンス - ENS

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

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ens:DescribeFileSystems

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
EnsRegionId	string	任意	リージョンの ID です。	cn-beijing-cmcc
FileSystemId	string	任意	ファイルシステムの ID です。	c50f8*****
FileSystemName	string	任意	ファイルシステムの名前です。	FileSystem1
PageNumber	integer	任意	ページ番号です。ページは 1 から始まります。デフォルト値は 1 です。	1
PageSize	integer	任意	1 ページあたりの表示件数です。最大値は 100 です。デフォルト値は 10 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマです。
PageNumber	integer	ページ番号です。	1
PageSize	integer	1 ページあたりの表示件数です。	2
TotalCount	integer	返された合計件数です。	1
FileSystems	array<object>	ファイルシステムに関する情報です。
	array<object>
FileSystemId	string	ファイルシステムの ID です。	c50f8*****
FileSystemName	string	ファイルシステムの名前です。	FileSystem1
EnsRegionId	string	リージョンの ID です。	cn-beijing-cmcc
StorageType	string	ストレージタイプです。有効な値は以下のとおりです。 capacity：容量型 NAS ファイルシステム performance：パフォーマンス最適化 NAS ファイルシステム	capacity
ProtocolType	string	ファイルシステムのプロトコルタイプです。有効な値は以下のとおりです。 NFS：ネットワークファイルシステム (NFS) SMB：サーバーメッセージブロック (SMB)	NFS
Capacity	integer	ファイルシステムの容量です。単位は MiB です。	100000
MeteredSize	integer	ファイルシステムのストレージ使用量です。このパラメーターの値は、過去 1 時間におけるファイルシステムの最大ストレージ使用量を示します。単位はバイトです。	102400
Status	string	ファイルシステムのステータスです。有効な値は以下のとおりです。 pending：ファイルシステムが作成中または変更中です。 running：ファイルシステムが利用可能です。マウントポイントを作成する前に、ファイルシステムのステータスが「running」であることを確認してください。 stopped：ファイルシステムが利用できません。 extending：ファイルシステムがスケールアウト中です。 stopping：ファイルシステムが無効化中です。 deleting：ファイルシステムが削除中です。	running
PayType	string	課金方法です。「PostPaid」が返されます。これは従量課金（ポストペイド）方式を意味します。	PostPaid
CreationTime	string	ファイルシステムが作成された時刻です。	2022-08-31 12:00:00
MountTargets	array<object>	マウントポイントに関する情報です。
	object
MountTargetDomain	string	マウントポイントのパスです。	...:/${FileSystemName}/{MountTargetName}
MountTargetName	string	マウントポイントの名前です。	target1
NetWorkId	string	ネットワークの ID です。	n-****
Status	string	マウントポイントのステータスです。有効な値は以下のとおりです。 active：マウントポイントが利用可能です。 inactive：マウントポイントが利用できません。 pending：タスクが実行中です。 deleting：マウントポイントが削除中です。	active
Description	string	説明です。	test
RequestId	string	リクエストの ID です。	762DD527-358B-1E48-8005-CCE3ED4EB9E0

例

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "PageSize": 2,
  "TotalCount": 1,
  "FileSystems": [
    {
      "FileSystemId": "c50f8*****",
      "FileSystemName": "FileSystem1",
      "EnsRegionId": "cn-beijing-cmcc",
      "StorageType": "capacity",
      "ProtocolType": "NFS",
      "Capacity": 100000,
      "MeteredSize": 102400,
      "Status": "running",
      "PayType": "PostPaid",
      "CreationTime": "2022-08-31 12:00:00",
      "MountTargets": [
        {
          "MountTargetDomain": "*.*.*.*:/${FileSystemName}/{MountTargetName}",
          "MountTargetName": "target1",
          "NetWorkId": "n-****",
          "Status": "active"
        }
      ],
      "Description": "test"
    }
  ],
  "RequestId": "762DD527-358B-1E48-8005-CCE3ED4EB9E0"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	Permission denied.
400	ens.interface.error	Failed to call API.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

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

変更履歴

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