すべてのプロダクト
Search

このプロダクト

    Cloud Parallel File Storage:DescribeFilesets

    ドキュメントセンター

    Cloud Parallel File Storage:DescribeFilesets

    最終更新日:Jun 25, 2026

    作成済みのファイルセットのリストを照会します。

    操作説明

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

    • フィルターキー (Filters) について、FsetIds は完全に一致する必要がありますが、FileSystemPath と Description はあいまい一致をサポートしています。

    • 組み合わせクエリがサポートされています。

    今すぐお試しください

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

    list

    *FileSystem

    acs:nas:{#regionId}:{#accountId}:filesystem/{#FileSystemId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileSystemId

    string

    必須

    ファイルシステム ID。

    • CPFS: ID は cpfs- で始まる必要があります（例: cpfs-099394bd928c****）。

    • CPFS for Lingjun: ID は bmcpfs- で始まる必要があります（例: bmcpfs-290w65p03ok64ya****）。

    bmcpfs-290w65p03ok64ya****
    Filters

    array<object>

    任意

    クエリするファイルセットのフィルターキー情報。

    object

    任意

    Key

    string

    任意

    フィルターキーの名前。有効な値:

    • FsetIds: ファイルセット ID でフィルタリングします。

    • FileSystemPath: CPFS ファイルシステム内のファイルセットのパスでフィルタリングします。

    • Description: ファイルセットの説明でフィルタリングします。

    • QuotaExists: クォータが存在するかどうかでフィルタリングします。

    説明

    CPFS for Lingjun 2.7.0 以降のみが QuotaExists パラメーターによるフィルタリングをサポートしています。

    列挙値:

    • FileSystemPath :

      根据 Fileset 在 CPFS 文件系统中的路径筛选

    • Description :

      根据 Fileset 的描述筛选

    • FsetIds :

      根据 Fileset ID 筛选

    • QuotaExists :

      根据 Quota 是否存在进行筛选

    FsetIds
    Value

    string

    任意

    フィルターキーの値。このパラメーターではワイルドカードはサポートされていません。

    • Key が FsetIds に設定されている場合、Value はファイルセット ID に設定されます。1 つ以上のファイルセット ID を最大 10 個指定できます。複数の値はコンマ (,) で区切ります。例: fset-1902718ea0ae**** または fset-1902718ea0ae****,fset-3212718ea0ae****。

    • Key が FileSystemPath に設定されている場合、Value は CPFS ファイルシステム内のファイルセットの完全パスまたは部分パスに設定されます。値は 2～1,024 文字で、UTF-8 でエンコードされている必要があります。

    • Key が Description に設定されている場合、Value はファイルセットの完全な説明または部分的な説明に設定されます。

    • Key が QuotaExists に設定されている場合、Value は true または false に設定されます。このパラメーターを空のままにすると、すべてのファイルセットが返されます。

    fset-1902718ea0ae****
    NextToken

    string

    任意

    新しいページの結果を取得するために次のリクエストで使用されるページネーショントークン。返された結果が切り捨てられている場合、このトークンを次のリクエストで使用して残りの結果を取得できます。

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    MaxResults

    integer

    任意

    クエリあたりの結果数。

    有効な値: 10～100。デフォルト値: 20。

    20
    OrderByField

    string

    任意

    結果のソートに使用するフィールド。

    • FileCountLimit: クォータファイル数制限。

    • SizeLimit: クォータ容量制限。

    • FileCountUsage: ファイル数使用量。

    • SpaceUsage: 容量使用量。

    列挙値:

    • SpaceUsage :

      容量使用量。

    • FileCountLimit :

      クォータファイル数制限。

    • SizeLimit :

      クォータ容量制限。

    • FileCountUsage :

      ファイル数使用量。

    FileCountLimit
    SortOrder

    string

    任意

    ソート順序。有効な値:

    • asc (デフォルト): 昇順。結果を小さい順にソートします。

    • desc: 降順。結果を大きい順にソートします。

    説明

    このパラメーターは OrderByField パラメーターが指定されている場合にのみ有効です。

    列挙値:

    • asc :

      昇順。

    • desc :

      降順。

    asc

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    2D69A58F-345C-4FDE-88E4-BF518948****
    NextToken

    string

    新しいページの結果を取得するために次のリクエストで使用されるページネーショントークン。返された結果が切り捨てられている場合、このトークンを次のリクエストで使用して残りの結果を取得できます。

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    FileSystemId deprecated

    string

    ファイルシステム ID。

    • CPFS: ID は cpfs- で始まる必要があります（例: cpfs-099394bd928c****）。

    • CPFS for Lingjun: ID は bmcpfs- で始まる必要があります（例: bmcpfs-290w65p03ok64ya****）。

    bmcpfs-290w65p03ok64ya****
    Entries

    object

    Entrie

    array<object>

    ファイルセット情報のコレクション。

    array<object>

    ファイル情報のコレクション。

    Description

    string

    ファイルセットの説明。

    test
    FileSystemPath

    string

    ファイルセットのパス。

    pathtoroot/fset
    FsetId

    string

    ファイルセット ID。

    fset-1902718ea0ae****
    Status

    string

    ファイルセットのステータス。有効な値：

    • CREATING：ファイルセットは作成中です。

    • CREATED：ファイルセットは作成され、正常に実行されています。

    • RELEASING：ファイルセットはリリース中です。

    • RELEASED：ファイルセットは削除されました。

    CREATED
    CreateTime

    string

    ファイルセットが作成された時刻。

    時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。

    2021-09-30T10:08:08Z
    UpdateTime

    string

    ファイルセットが最後に更新された時刻。

    時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準に準拠しています。

    2021-09-30T10:08:08Z
    DeletionProtection

    boolean

    コンソールを使用するか、 DeleteFileset 操作を呼び出してファイルセットをリリースできるように、削除保護を有効にするかどうかを指定します。有効な値：

    • true：リリース保護を有効にします。

    • false：リリース保護を無効にします。

    説明

    このパラメーターは、手動解放からのみファイルセットを保護できますが、自動リリースからは保護できません。

    true
    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

    容量クォータ。単位：バイト。

    • 最小値：10737418240 (10 GiB)。

    • ステップサイズ：1073741824 (1 GiB)。

    10737418240
    FileCountLimit

    integer

    ファイル数クォータ。有効な値：

    • 最小値：10000。

    • 最大値：10000000000。

    10000
    FileSystemId

    string

    ファイルシステム ID。

    • CPFS ファイルシステムの ID は cpfs- で始まる必要があります。例：cpfs-099394bd928c****。

    • CPFS for LINGJUN ファイルシステムの ID は bmcpfs- で始まる必要があります。例：bmcpfs-290w65p03ok64ya****。

    bmcpfs-290w65p03ok64ya****

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "FileSystemId": "bmcpfs-290w65p03ok64ya****",
  "Entries": {
    "Entrie": [
      {
        "Description": "test",
        "FileSystemPath": "pathtoroot/fset",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "CREATED",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "DeletionProtection": true,
        "FileCountUsage": 1024,
        "SpaceUsage": 1024,
        "Quota": {
          "SizeLimit": 10737418240,
          "FileCountLimit": 10000
        },
        "FileSystemId": "bmcpfs-290w65p03ok64ya****"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalCharacters The parameter contains illegal characters.
    400 MissingFileSystemId FileSystemId is mandatory for this action.
    400 InvalidParameter.SortOrder Invalid sort order.
    400 InvalidParameter.SortOrderField Invalid sort order field.
    403 OperationDenied.FilesetNotSupported The operation is not supported.
    404 InvalidFileSystem.NotFound The specified file system does not exist.
    404 InvalidFilterParam The specified Filter.N.Key is invalid.
    404 InvalidFilterValue The specified Filter.N.Value is invalid.
    404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
    404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid.

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

    変更履歴

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