ListAvailableFileSystems API 概要 - E-HPC

指定リージョンでアタッチ可能なファイルシステムを照会します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ehpc:ListAvailableFileSystems

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	返されるページのページ番号。ページは 1 から始まります。デフォルト値：1	1
PageSize	integer	任意	1 ページあたりのエントリ数。有効な値：1～50。デフォルト値：10	10

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
RequestId	string	リクエスト ID。	BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**
TotalCount	integer	返されたエントリの合計数。	65
PageSize	integer	1 ページあたりのエントリ数。	10
PageNumber	integer	ページ番号。	1
FileSystemList	array<object>	ファイルシステム。
	array<object>	ファイルシステムの情報。
FileSystemId	string	ファイルシステムの ID。	2fa0248***
FileSystemType	string	ファイルシステムのタイプ。有効な値： standard：汎用ネットワーク接続ストレージ（NAS）ファイルシステム extreme：Extreme NAS ファイルシステム	cpfs
Status	string	ファイルシステムの状態。有効な値： Pending：ファイルシステムがタスクを処理中です。 Running：ファイルシステムが利用可能です。マウントポイントの作成などの後続操作は、ファイルシステムの状態が Running の場合にのみ実行できます。 Stopped：ファイルシステムが利用できません。 Extending：ファイルシステムがスケールアウト中です。 Stopping：ファイルシステムが停止中です。 Deleting：ファイルシステムが削除中です。	Running
ProtocolType	string	ファイルシステムのプロトコルタイプ。有効な値： nfs smb cpfs	cpfs
CreateTime	string	ファイルシステムが作成された時刻。	2024-7-29 15:43:53
MountTargetList	array<object>	ファイルシステムのマウントポイント。
	object	マウントポイントの情報。
VpcId	string	VPC ID。	vpc-8vbvb34rtyh6xb3zrehs1****
MountTargetDomain	string	マウントポイントのアドレス。	c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com
Status	string	マウントポイントの状態。有効な値： Active：マウントポイントが利用可能です。 Inactive：マウントポイントが利用できません。 Pending：マウントポイントがマウント中です。 Deleting：マウントポイントが削除中です。	Active
VSwitchId	string	vSwitch ID。	vsw-2ze0c41hwu7lc29ris***
NetworkType	string	ネットワークタイプ。有効な値： vpc	vpc
StorageType	string	ファイルシステムのストレージタイプ。 FileSystemType が standard の場合の有効な値：Capacity、Performance FileSystemType が extreme の場合の有効な値：standard、advance	Performance
VpcId	string	VPC ID。	vpc-bp132kgui8n0targb****

例

成功レスポンス

JSONJSON

{
  "RequestId": "BF4E8AB1-02A3-5ECF-87CC-3AB7BE98**",
  "TotalCount": 65,
  "PageSize": 10,
  "PageNumber": 1,
  "FileSystemList": [
    {
      "FileSystemId": "2fa0248***",
      "FileSystemType": "cpfs",
      "Status": "Running",
      "ProtocolType": "cpfs",
      "CreateTime": "2024-7-29 15:43:53",
      "MountTargetList": [
        {
          "VpcId": "vpc-8vbvb34rtyh6xb3zrehs1****",
          "MountTargetDomain": "c0967****.cn-hangzhou.cpfs.nas.aliyuncs.com",
          "Status": "Active",
          "VSwitchId": "vsw-2ze0c41hwu7lc29ris***",
          "NetworkType": "vpc"
        }
      ],
      "StorageType": "Performance",
      "VpcId": "vpc-bp132kgui8n0targb****"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParams	The specified parameter %s is invalid.
404	ClusterNotFound	The specified cluster does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server
406	NasError	NAS API request failed.
406	EcsError	An error occurred while calling the ECS API operation.
406	AliyunError	An Alibaba Cloud product error occurred.

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

変更履歴

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