All Products
Search

This Product

    File Storage NAS:DescribeSnapshots

    Document Center

    File Storage NAS:DescribeSnapshots

    Last Updated:Jul 15, 2026

    Mengkueri informasi tentang satu atau beberapa snapshot dari sistem file tertentu.

    Deskripsi operasi

    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

    Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

    • Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.

    • API: API yang dapat Anda panggil untuk melakukan aksi tersebut.

    • Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.

    • Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.

      • Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.

      • Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.

    • Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.

    • Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    nas:DescribeSnapshots

    get

    *Snapshot

    acs:nas:{#regionId}:{#accountId}:snapshot/*

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    FileSystemType

    string

    No

    Jenis sistem file.

    Nilai valid: extreme (sistem file Extreme NAS)

    Valid values:

    • extreme :

      Sistem file Extreme NAS.

    extreme
    FileSystemId

    string

    No

    ID sistem file.

    extreme-22f****
    SnapshotIds

    string

    No

    ID snapshot.

    Anda dapat menentukan beberapa ID snapshot yang dipisahkan oleh koma (,). Maksimal 100 ID didukung.

    s-extreme-67pxwk9aevrkr****,s-extreme-snapsho****,s-extreme-6tmsbas6ljhwh****
    SnapshotName

    string

    No

    Nama snapshot.

    FinanceJoshua
    SnapshotType

    string

    No

    Tipe snapshot.

    Nilai valid:

    • auto: Snapshot otomatis

    • user: snapshot yang dibuat secara manual

    • all (default): semua tipe snapshot

    Valid values:

    • all :

      semua tipe snapshot.

    • auto :

      Snapshot otomatis.

    • user :

      snapshot yang dibuat secara manual.

    all
    Status

    string

    No

    Status snapshot.

    Nilai valid:

    • progressing: Snapshot sedang dibuat.

    • accomplished: Snapshot telah dibuat.

    • failed: Gagal membuat snapshot.

    • all (default): semua status snapshot

    Valid values:

    • all :

      semua status snapshot.

    • accomplished :

      Snapshot telah dibuat.

    • progressing :

      Snapshot sedang dibuat.

    • failed :

      Gagal membuat snapshot.

    all
    PageSize

    integer

    No

    Jumlah entri per halaman dalam kueri berhalaman. Pengaturan jumlah baris per halaman dalam paging.

    Nilai valid: 1 hingga 100.

    Nilai default: 10.

    10
    PageNumber

    integer

    No

    Nomor halaman dari daftar snapshot.

    Nilai default: 1.

    1

    Elemen respons

    Element

    Type

    Description

    Example

    object

    TotalCount

    integer

    Jumlah total snapshot.

    36
    RequestId

    string

    ID permintaan.

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
    PageSize

    integer

    Jumlah entri per halaman.

    10
    PageNumber

    integer

    Nomor halaman dari daftar snapshot.

    1
    Snapshots

    object

    Snapshot

    array<object>

    Detail snapshot.

    object

    Status

    string

    Status snapshot.

    Nilai valid:

    • progressing: Snapshot sedang dibuat.

    • accomplished: Snapshot telah dibuat.

    • failed: Snapshot gagal dibuat.

    accomplished
    Progress

    string

    Progres pembuatan snapshot. Nilai dinyatakan dalam persentase.

    100
    CreateTime

    string

    Waktu pembuatan snapshot.

    Waktu mengikuti standar ISO 8601 dan ditampilkan dalam UTC. Formatnya adalah yyyy-MM-ddThh:mmZ.

    2014-07-24T13:00:52Z
    SourceFileSystemId

    string

    ID sistem file sumber.

    Jika sistem file sumber snapshot telah dihapus, bidang ini tetap dipertahankan.

    extreme-012****
    RetentionDays

    integer

    Periode retensi snapshot otomatis.

    Unit: hari.

    Nilai valid:

    • -1: Snapshot otomatis dipertahankan secara permanen. Ketika jumlah snapshot mencapai batas atas, snapshot otomatis terlama akan dihapus secara otomatis.

    • 1 hingga 65536: Periode retensi yang ditentukan. Snapshot otomatis akan dilepaskan secara otomatis setelah periode retensi berakhir.

    30
    RemainTime

    integer

    Sisa waktu yang diperlukan untuk membuat snapshot.

    Unit: detik.

    38
    SourceFileSystemSize

    integer

    Kapasitas sistem file sumber.

    Unit: GiB.

    2000
    SourceFileSystemVersion

    string

    Versi sistem file sumber.

    1
    SnapshotName

    string

    Nama snapshot.

    Jika nama snapshot ditentukan saat snapshot dibuat, nama snapshot akan dikembalikan. Jika tidak ada nama snapshot yang ditentukan saat snapshot dibuat, parameter ini tidak dikembalikan.

    FinanceJoshua
    EncryptType

    integer

    Jenis enkripsi.

    Nilai valid:

    • 0: tidak dienkripsi

    • 1: dienkripsi.

    1
    Description

    string

    Deskripsi API.

    FinanceDept
    SnapshotId

    string

    ID snapshot.

    s-extreme-snapsho****
    FileSystemType

    string

    Jenis sistem file.

    extreme
    SnapshotType

    string

    Jenis snapshot. Nilai valid:

    • auto: snapshot yang dibuat secara otomatis

    • user: snapshot yang dibuat secara manual.

    user
    CompletedTime

    string

    Waktu penyelesaian snapshot.

    Waktu mengikuti standar ISO 8601 dan ditampilkan dalam UTC. Formatnya adalah yyyy-MM-ddThh:mmZ.

    Catatan

    Bidang ini hanya valid ketika status snapshot adalah accomplished. Selama pembuatan snapshot, nilai bidang ini sama dengan nilai CreateTime.

    2014-07-24T13:10:52Z

    Contoh

    Respons sukses

    JSONformat

    {
  "TotalCount": 36,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "Progress": "100",
        "CreateTime": "2014-07-24T13:00:52Z",
        "SourceFileSystemId": "extreme-012****",
        "RetentionDays": 30,
        "RemainTime": 38,
        "SourceFileSystemSize": 2000,
        "SourceFileSystemVersion": "1",
        "SnapshotName": "FinanceJoshua",
        "EncryptType": 1,
        "Description": "FinanceDept",
        "SnapshotId": "s-extreme-snapsho****",
        "FileSystemType": "extreme",
        "SnapshotType": "user",
        "CompletedTime": "2014-07-24T13:10:52Z"
      }
    ]
  }
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.