GetFileset - Cloud Parallel File Storage - Alibaba Cloud ドキュメントセンター

作成されたファイルセットの情報を照会します。

操作説明

Fileset は、CPFS 2.2.0 および CPFS for Lingjun 2.7.0 以降のバージョンでのみサポートされています。バージョン情報は、コンソールのファイルシステムの詳細ページで確認できます。

今すぐお試しください

この 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:GetFileset

get

*All Resource

*

なし

リクエスト構文

GET  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
FileSystemId	string	必須	ファイルシステムの ID。 CPFS ファイルシステムの ID は `cpfs-` で始まる必要があります。例：cpfs-125487**。 CPFS for Lingjun ファイルシステムの ID は `bmcpfs-` で始まる必要があります。例：bmcpfs-0015**。	cpfs-099394bd928c****
FsetId	string	必須	ファイルセット ID。説明このパラメーターは CPFS ファイルシステムに必須です。	fset-1902718ea0ae****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス情報
RequestId	string	リクエスト ID。	BC7C825C-5F65-4B56-BEF6-98C56C7C****
Data	object	レスポンスパラメーター。
Description	string	ファイルセットの説明。	Description
FileSystemPath	string	CPFS ファイルシステムにおけるファイルセットのディレクトリ。	pathtoroot/fset/
FsetId	string	ファイルセット ID。説明このパラメーターは CPFS ファイルシステムに必須です。	fset-03250e8fe78d****
Status	string	ファイルセットのステータス。有効値： CREATING：ファイルセットは作成中です。 CREATED：ファイルセットは作成され、正常に実行されています。 RELEASING：ファイルセットはリリース中です。 RELEASED：ファイルセットは削除されました。	CREATED
CreateTime	string	ファイルセットが作成された時刻。戻り値のフォーマット： `yyyy-MM-dd HH:mm:ss`	2025-11-21 12:49:25
UpdateTime	string	ファイルセットが最後に更新された時刻。戻り値のフォーマット： `yyyy-MM-dd HH:mm:ss`	2025-11-22 12:49:25
DeletionProtection	boolean	コンソールまたは DeleteFileset 操作によるファイルセットのリリースから保護するかどうかを指定します。 true：リリース保護を有効にします。ファイルセットはリリースできません。 false (デフォルト)：リリース保護を無効にします。ファイルセットはリリースできます。説明このパラメーターは手動解放からのみファイルセットを保護でき、自動リリースからは保護できません。	false
FileCountUsage	integer	ファイル数量の使用量。説明 CPFS for Lingjun V2.7.0 以降のみがこのパラメーターをサポートします。	1024
SpaceUsage	integer	容量の使用量。単位：バイト。説明 CPFS for Lingjun V2.7.0 以降のみがこのパラメーターをサポートします。	1024
Quota	object	クォータ情報。説明 CPFS for Lingjun V2.7.0 以降のみがこのパラメーターをサポートします。
SizeLimit	integer	合計クォータ容量の上限。単位：バイト。有効値：最小値：10,737,418,240 (10 GiB)。ステップサイズ：1,073,741,824 (1 GiB)。	10,737,418,240
FileCountLimit	integer	ファイル数量のクォータ。有効値：最小値：10,000。最大値：10,000,000,000。	10001
FileSystemId	string	ファイルシステムの ID。 CPFS ファイルシステムの ID は `cpfs-` で始まる必要があります。例：cpfs-125487**。 CPFS for Lingjun ファイルシステムの ID は `bmcpfs-` で始まる必要があります。例：bmcpfs-0015**。	cpfs-0244729a8ef8****

例

成功レスポンス

JSONJSON

{
  "RequestId": "BC7C825C-5F65-4B56-BEF6-98C56C7C****",
  "Data": {
    "Description": "Description",
    "FileSystemPath": "pathtoroot/fset/",
    "FsetId": "fset-03250e8fe78d****",
    "Status": "CREATED",
    "CreateTime": "2025-11-21 12:49:25",
    "UpdateTime": "2025-11-22 12:49:25",
    "DeletionProtection": false,
    "FileCountUsage": 1024,
    "SpaceUsage": 1024,
    "Quota": {
      "SizeLimit": 0,
      "FileCountLimit": 10001
    },
    "FileSystemId": "cpfs-0244729a8ef8****"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	IllegalCharacters	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.
403	OperationDenied.FilesetNotSupported	The operation is not supported.
404	InvalidFileSystem.NotFound	The specified filesystem does not exist.

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

変更履歴

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