All Products
Search

This Product

    Cloud Parallel File Storage:DescribeFilesets

    Document Center

    Cloud Parallel File Storage:DescribeFilesets

    Last Updated:Aug 14, 2026

    Menampilkan daftar fileset yang telah dibuat.

    Deskripsi operasi

    • Hanya CPFS versi 2.2.0 ke atas dan CPFS for Lingjun versi 2.7.0 ke atas yang mendukung fileset. Informasi versi dapat dilihat pada halaman detail sistem file di Konsol.

    • Untuk kunci filter (Filters), FsetIds memerlukan pencocokan eksak, sedangkan FileSystemPath dan Description mendukung pencocokan kabur (fuzzy match).

    • Kueri kombinasi didukung.

    Coba sekarang

    Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

    Test

    RAM authorization

    Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    FileSystemId

    string

    Yes

    ID sistem file.

    • CPFS: ID harus diawali dengan cpfs-, contohnya cpfs-099394bd928c****.

    • CPFS for Lingjun: ID harus diawali dengan bmcpfs-, contohnya bmcpfs-290w65p03ok64ya****.

    Catatan

    Operasi ini hanya mendukung sistem file CPFS (dengan awalan ID cpfs-* atau bmcpfs-*). Sistem file NAS tujuan umum dan sistem file NAS Ekstrem tidak didukung.

    bmcpfs-290w65p03ok64ya****
    Filters

    array<object>

    No

    Informasi kunci filter untuk fileset yang akan ditanyakan.

    object

    No

    Key

    string

    No

    Nama kunci filter. Nilai yang valid:

    • FsetIds: memfilter berdasarkan ID fileset.

    • FileSystemPath: memfilter berdasarkan path fileset dalam sistem file CPFS.

    • Description: memfilter berdasarkan deskripsi fileset.

    • QuotaExists: memfilter berdasarkan apakah kuota ada atau tidak.

    Catatan

    Hanya CPFS for Lingjun 2.7.0 ke atas yang mendukung pemfilteran berdasarkan parameter QuotaExists.

    Valid values:

    • FileSystemPath :

      memfilter berdasarkan path fileset dalam sistem file CPFS.

    • Description :

      memfilter berdasarkan deskripsi fileset.

    • FsetIds :

      memfilter berdasarkan ID fileset.

    • QuotaExists :

      memfilter berdasarkan apakah kuota ada atau tidak.

    FsetIds
    Value

    string

    No

    Nilai kunci filter. Karakter wildcard tidak didukung untuk parameter ini.

    • Jika Key diatur ke FsetIds, Value diatur ke ID fileset. Anda dapat menentukan satu atau beberapa ID fileset, maksimal 10. Pisahkan beberapa nilai dengan koma (,). Contoh: fset-1902718ea0ae**** atau fset-1902718ea0ae****,fset-3212718ea0ae****.

    • Jika Key diatur ke FileSystemPath, Value diatur ke path atau sebagian path fileset dalam sistem file CPFS. Nilai harus terdiri dari 2 hingga 1.024 karakter dan dikodekan dalam UTF-8.

    • Jika Key diatur ke Description, Value diatur ke deskripsi atau sebagian deskripsi fileset.

    • Jika Key diatur ke QuotaExists, Value diatur ke true atau false. Jika parameter ini dibiarkan kosong, semua fileset akan dikembalikan.

    fset-1902718ea0ae****
    NextToken

    string

    No

    Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika hasil yang dikembalikan terpotong, gunakan NextToken untuk memulai permintaan baru guna mengambil konten setelah titik potong tersebut.

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    MaxResults

    integer

    No

    Jumlah hasil untuk setiap kueri.

    Nilai yang valid: 10 hingga 100. Nilai default: 20.

    20
    OrderByField

    string

    No

    Bidang yang digunakan untuk pengurutan.

    • FileCountLimit: batas jumlah file kuota.

    • SizeLimit: batas kapasitas kuota.

    • FileCountUsage: penggunaan jumlah file.

    • SpaceUsage: penggunaan kapasitas.

    Valid values:

    • SpaceUsage :

      penggunaan kapasitas.

    • FileCountLimit :

      batas jumlah file kuota.

    • SizeLimit :

      batas kapasitas kuota.

    • FileCountUsage :

      penggunaan jumlah file.

    FileCountLimit
    SortOrder

    string

    No

    Urutan pengurutan.

    • asc (default): urutan menaik, yang mengurutkan hasil dari terkecil ke terbesar.

    • desc: urutan menurun, yang mengurutkan hasil dari terbesar ke terkecil.

    Catatan

    Bidang ini hanya berlaku jika parameter OrderByField ditentukan.

    Valid values:

    • asc :

      urutan menaik.

    • desc :

      urutan menurun.

    asc

    Elemen respons

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    ID permintaan.

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

    string

    Token paginasi yang digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru. Jika hasil yang dikembalikan terpotong, gunakan NextToken untuk memulai permintaan baru guna mengambil konten setelah titik potong tersebut.

    TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    FileSystemId deprecated

    string

    ID sistem file.

    • CPFS: ID diawali dengan cpfs-, contohnya cpfs-099394bd928c****.

    • CPFS for Lingjun: ID diawali dengan bmcpfs-, contohnya bmcpfs-290w65p03ok64ya****.

    bmcpfs-290w65p03ok64ya****
    Entries

    object

    Entrie

    array<object>

    Kumpulan informasi fileset.

    array<object>

    Kumpulan informasi file.

    Description

    string

    Deskripsi fileset.

    test
    FileSystemPath

    string

    Path fileset.

    pathtoroot/fset
    FsetId

    string

    ID fileset。

    fset-1902718ea0ae****
    Status

    string

    Status fileset. Nilai yang valid:

    • CREATING: Fileset sedang dibuat.

    • CREATED: Fileset telah dibuat dan berjalan normal.

    • RELEASING: Fileset sedang dilepas.

    • RELEASED: Fileset telah dihapus.

    CREATED
    CreateTime

    string

    Waktu saat fileset dibuat.

    Waktu mengikuti standar ISO 8601 dalam format: yyyy-MM-ddTHH:mm:ssZ.

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

    string

    Waktu saat fileset terakhir diperbarui.

    Waktu mengikuti standar ISO 8601 dalam format: yyyy-MM-ddTHH:mm:ssZ.

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

    boolean

    Properti perlindungan pelepasan instans. Menentukan apakah instans dapat dilepas dari Konsol atau dengan memanggil operasi DeleteFileset.

    • true: Perlindungan pelepasan diaktifkan.

    • false: Perlindungan pelepasan dinonaktifkan.

    Catatan

    Properti ini hanya membatasi operasi pelepasan manual dan tidak berlaku untuk operasi pelepasan yang diprakarsai sistem.

    true
    FileCountUsage

    integer

    Penggunaan jumlah file.

    Catatan

    Hanya CPFS for Lingjun 2.7.0 ke atas yang mendukung parameter ini.

    1024
    SpaceUsage

    integer

    Penggunaan kapasitas. Satuan: byte.

    Catatan

    Hanya CPFS for Lingjun 2.7.0 ke atas yang mendukung parameter ini.

    1024
    Quota

    object

    Informasi kuota.

    Catatan

    Hanya CPFS for Lingjun 2.7.0 ke atas yang mendukung parameter ini.

    SizeLimit

    integer

    Batas kapasitas kuota. Satuan: byte.

    • Nilai minimum: 10.737.418.240 (10 GiB).

    • Increment: 1.073.741.824 (1 GiB).

    10737418240
    FileCountLimit

    integer

    Batas jumlah file kuota. Nilai yang valid:

    • Nilai minimum: 10.000.

    • Nilai maksimum: 10.000.000.000.

    10000
    FileSystemId

    string

    ID sistem file.

    • CPFS: ID diawali dengan cpfs-, contohnya cpfs-099394bd928c****.

    • CPFS for Lingjun: ID diawali dengan bmcpfs-, contohnya bmcpfs-290w65p03ok64ya****.

    bmcpfs-290w65p03ok64ya****

    Contoh

    Respons sukses

    JSONformat

    {
  "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****"
      }
    ]
  }
}

    Kode kesalahan

    HTTP status code

    Error code

    Error message

    Description
    400 IllegalCharacters The parameter contains illegal characters. Parameter tidak valid.
    400 MissingFileSystemId FileSystemId is mandatory for this action. Parameter FileSystemId tidak ditentukan.
    400 InvalidParameter.SortOrder Invalid sort order. Parameter SortOrder tidak valid.
    400 InvalidParameter.SortOrderField Invalid sort order field. Parameter SortOrderField tidak valid.
    400 InvalidFilesystemType.NotSupport The API operation does not support the file system type. Operasi saat ini tidak mendukung tipe sistem file ini.
    403 OperationDenied.FilesetNotSupported The operation is not supported. Sistem file tidak mendukung Fileset.
    404 InvalidFileSystem.NotFound The specified file system does not exist. Sistem file yang ditentukan tidak ada.
    404 InvalidFilterParam The specified Filter.N.Key is invalid. Parameter Filter.N.Key yang ditentukan tidak valid.
    404 InvalidFilterValue The specified Filter.N.Value is invalid. Parameter Filter.N.Value yang ditentukan tidak valid.
    404 InvalidParameter.InvalidNextToken The specified NextToken is invaild.
    404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. MaxResults yang ditentukan tidak valid.

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.