すべてのプロダクト
Search

このプロダクト

    Cloud Parallel File Storage:DescribeFilesets

    ドキュメントセンター

    Cloud Parallel File Storage:DescribeFilesets

    最終更新日:Aug 13, 2026

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

    操作説明

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

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

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

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    FileSystemId

    string

    必須

    ファイルシステムの ID。

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

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

    説明

    この操作は、CPFS ファイルシステム (ID プレフィックスが cpfs-* または bmcpfs-*) のみをサポートしています。汎用 NAS およびエクストリーム NAS ファイルシステムはサポートされていません。

    bmcpfs-290w65p03ok64ya****
    Filters

    array<object>

    任意

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

    object

    任意

    Key

    string

    任意

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

    • FsetIds: ファイルセット ID でフィルター処理します。

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

    • Description: ファイルセットの説明でフィルター処理します。

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

    説明

    QuotaExists パラメーターによるフィルター処理は、CPFS for Lingjun 2.7.0 以降でのみサポートされています。

    列挙値:

    • FileSystemPath :

      CPFS ファイルシステム内のファイルセットのパスでフィルター処理します。

    • Description :

      ファイルセットの説明でフィルター処理します。

    • FsetIds :

      ファイルセット ID でフィルター処理します。

    • QuotaExists :

      クォータが存在するかどうかでフィルター処理します。

    FsetIds
    Value

    string

    任意

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

    • Key が FsetIds に設定されている場合、Value にはファイルセット ID を設定します。ファイルセット ID は 1 つ以上指定でき、最大値は 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

    任意

    結果の新しいページを取得するために次のリクエストで使用されるページネーショントークン。返された結果が切り捨てられている場合は、NextToken を使用して新しいリクエストを開始し、切り捨てポイント以降の内容を取得します。

    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

    結果の新しいページを取得するために次のリクエストで使用されるページネーショントークン。返された結果が切り捨てられている場合は、NextToken を使用して新しいリクエストを開始し、切り捨てポイント以降の内容を取得します。

    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

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

    時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ のフォーマットで表されます。

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

    string

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

    時間は ISO 8601 標準に従い、yyyy-MM-ddTHH:mm:ssZ のフォーマットで表されます。

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

    boolean

    インスタンスのリリース保護プロパティ。コンソールまたは DeleteFileset 操作の呼び出しによってインスタンスをリリースできるかどうかを指定します。

    • true: リリース保護が有効です。

    • false: リリース保護が無効です。

    説明

    このプロパティは手動解放操作のみを制限し、システムによる解放操作には適用されません。

    true
    FileCountUsage

    integer

    ファイル数の使用量。

    説明

    このパラメーターは、CPFS for Lingjun 2.7.0 以降でのみサポートされています。

    1024
    SpaceUsage

    integer

    容量の使用量。単位: バイト。

    説明

    このパラメーターは、CPFS for Lingjun 2.7.0 以降でのみサポートされています。

    1024
    Quota

    object

    クォータ情報。

    説明

    このパラメーターは、CPFS for Lingjun 2.7.0 以降でのみサポートされています。

    SizeLimit

    integer

    クォータの容量制限。単位: バイト。

    • 最小値: 10,737,418,240 (10 GiB)。

    • 増分: 1,073,741,824 (1 GiB)。

    10737418240
    FileCountLimit

    integer

    クォータのファイル数制限。有効な値:

    • 最小値: 10,000。

    • 最大値: 10,000,000,000。

    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. FileSystemId パラメーターが指定されていません。
    400 InvalidParameter.SortOrder Invalid sort order. SortOrder パラメーターが無効です。
    400 InvalidParameter.SortOrderField Invalid sort order field. SortOrderField パラメーターが無効です。
    400 InvalidFilesystemType.NotSupport The API operation does not support the file system type. 現在の操作はこのタイプのファイルシステムをサポートしていません。
    403 OperationDenied.FilesetNotSupported The operation is not supported. ファイルシステムは Fileset をサポートしていません。
    404 InvalidFileSystem.NotFound The specified file system does not exist. 指定されたファイルシステムが存在しません。
    404 InvalidFilterParam The specified Filter.N.Key is invalid. 指定された Filter.N.Key パラメーターが無効です。
    404 InvalidFilterValue The specified Filter.N.Value is invalid. 指定された Filter.N.Value パラメーターが無効です。
    404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
    404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. 指定された MaxResults が無効です。

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

    変更履歴

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