All Products
Search

This Product

    Cloud Backup:ListSnapshots

    Document Center

    Cloud Backup:ListSnapshots

    Last Updated:Oct 29, 2026

    Mengkueri titik cadangan.

    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

    hbr:ListSnapshots

    list

    *Semua Sumber daya.

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    NextToken

    string

    No

    Token paginasi. Anda tidak perlu menentukan parameter ini untuk kueri pertama. Saat Anda mengkueri halaman berikutnya, atur parameter ini ke nilai NextToken yang dikembalikan dari halaman sebelumnya. Jika NextToken kosong, tidak ada halaman lagi. Parameter ini tidak dapat digunakan bersama dengan Skip.

    eyJJbmRleCI6NjUwMX0=
    MaxResults

    integer

    No

    Jumlah entri maksimum yang dikembalikan untuk kueri berhalaman. Nilai default: 10. Nilai harus lebih besar dari 1.

    10
    Skip

    integer

    No

    Jumlah entri yang dilewati. Nilai harus berupa bilangan bulat non-negatif dan kelipatan dari MaxResults. Parameter ini tidak dapat digunakan bersama dengan NextToken.

    0
    SourceType

    string

    Yes

    Tipe sumber data. Nilai harus sama dengan tipe sumber data dari sumber daya yang dilindungi yang ditentukan oleh ProtectedResourceId. Tipe sumber data yang didukung dijelaskan pada nilai valid.

    Valid values:

    • NAS :

      Cadangan NAS Alibaba Cloud.

    • COMMON_FILE_SYSTEM :

      Cadangan CPFS berbasis agen.

    • ECS_FILE :

      Cadangan file ECS.

    • COMMON_NAS :

      Cadangan NAS on-premises.

    • File :

      Cadangan file on-premises.

    • OSS :

      Cadangan OSS.

    ECS_FILE
    ProtectedResourceId

    string

    Yes

    ID sumber daya yang dilindungi. Sumber daya yang dilindungi harus ada, dan tipe sumber datanya harus sama dengan nilai parameter SourceType.

    pr-123***7890
    VaultId

    string

    No

    ID vault. Ini adalah filter opsional. Jika Anda menentukan parameter ini, hanya titik cadangan di vault yang ditentukan yang dikembalikan.

    v-00030j3c******sn
    CompleteTimeStart

    integer

    No

    Waktu mulai penyelesaian. Nilai berupa stempel waktu UNIX dalam detik. Hanya titik cadangan yang waktu penyelesaiannya lebih besar atau sama dengan nilai ini yang dikembalikan.

    1776059082
    CompleteTimeEnd

    integer

    No

    Waktu akhir penyelesaian. Nilai berupa stempel waktu UNIX dalam detik. Hanya titik cadangan yang waktu penyelesaiannya kurang dari nilai ini yang dikembalikan.

    1776059382
    PlanId

    string

    No

    ID rencana. Ini adalah filter opsional. Jika Anda menentukan parameter ini, hanya titik cadangan di bawah rencana cadangan yang ditentukan yang dikembalikan.

    po-0000****123

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Tanggapan.

    Code

    string

    Kode pengembalian. Nilai 200 menunjukkan keberhasilan.

    200
    MaxResults

    integer

    Jumlah hasil maksimum yang dikembalikan.

    10
    Message

    string

    Paket yang dikembalikan. Jika permintaan berhasil, "successful" dikembalikan. Jika terjadi error, paket error yang sesuai dikembalikan.

    successful
    NextToken

    string

    Token untuk halaman berikutnya. Jika NextToken kosong, tidak ada halaman lagi.

    aWQj********MCMy
    RequestId

    string

    ID permintaan.

    17189276-****-****-****-0FF51B5A41A0
    Snapshots

    array<object>

    Daftar titik cadangan.

    object

    Informasi titik cadangan.

    ActualBytes

    integer

    Jumlah data aktual yang ditulis, dalam byte.

    600
    ActualItems

    integer

    Jumlah item aktual.

    6
    ArchiveTime

    integer

    Waktu saat data diarsipkan.

    1640334062
    BackupType

    string

    Tipe cadangan. Nilai COMPLETE menunjukkan cadangan penuh.

    COMPLETE
    BytesDone

    integer

    Jumlah data yang dicadangkan, dalam byte.

    800
    BytesTotal

    integer

    Jumlah total data yang akan dicadangkan, dalam byte.

    1000
    ClientId

    string

    ID klien cadangan saat nilai SourceType adalah ECS_FILE atau File. Dalam kasus lain, parameter ini menunjukkan ID sumber data cadangan.

    c-*********************
    CompleteTime

    integer

    Waktu penyelesaian cadangan. Nilai berupa stempel waktu UNIX dalam detik.

    1642496679
    CreateTime

    integer

    Waktu saat titik cadangan dibuat, dalam detik.

    1607436917
    CreatedTime

    integer

    Waktu saat cadangan dibuat.

    1642496679
    ErrorFile

    string

    File yang mencatat informasi kegagalan cadangan, termasuk informasi tentang cadangan yang sebagian selesai.

    temp/report/123456789/job-xxxxxxxxx_failed.zip
    Exclude

    string

    Jalur sumber yang dikecualikan dari pekerjaan cadangan.

    [\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
    ExpireTime

    integer

    Waktu kedaluwarsa cadangan.

    1771901707
    Include

    string

    Jalur sumber yang disertakan dalam pekerjaan cadangan.

    [\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
    InstanceId

    string

    ID instans sumber data cadangan.

    i-*********************
    InstanceName

    string

    Nama instans Tablestore.

    instancename
    ItemsDone

    integer

    Jumlah item yang dicadangkan.

    8
    ItemsTotal

    integer

    Jumlah total item yang akan dicadangkan.

    10
    JobId

    string

    ID pekerjaan cadangan.

    job-00030j3chkt******2
    Path

    string

    Jalur cadangan.

    /home
    Paths

    array

    Daftar jalur cadangan.

    string

    Jalur cadangan.

    /home
    PlanId

    string

    ID rencana cadangan.

    po-123***7890
    ProtectedDataSize

    integer

    Ukuran data sumber yang dilindungi, dalam byte. Saat SourceType diatur ke ECS_FILE, parameter ini menunjukkan kapasitas cloud disk yang dilindungi.

    42949672960
    RangeEnd

    integer

    Waktu akhir pekerjaan cadangan Tablestore. Nilai berupa stempel waktu UNIX dalam milidetik.

    1642521709966
    RangeStart

    integer

    Waktu mulai pekerjaan cadangan Tablestore. Nilai berupa stempel waktu UNIX dalam milidetik.

    1642492553038
    Retention

    integer

    Periode retensi cadangan, dalam hari.

    7
    SnapshotHash

    string

    Nilai hash titik cadangan.

    f2ac5fd243**********************bc4451777be019
    SnapshotId

    string

    ID titik cadangan.

    s-00047mxg17p26*****b
    SourceType

    string

    Tipe sumber data. Nilai valid:

    • ECS_FILE: Cadangan file ECS.

    • File: Cadangan file on-premises.

    • OSS: Cadangan OSS.

    • NAS: Cadangan NAS Alibaba Cloud.

    • COMMON_NAS: Cadangan NAS on-premises.

    • CONTAINER: Cadangan kontainer.

    • OTS_TABLE: Cadangan Tablestore.

    • COMMON_FILE_SYSTEM: Cadangan CPFS berbasis agen.

    • CPFS: Cadangan CPFS tanpa agen.

    ECS_FILE
    Status

    string

    Status titik cadangan.

    Valid values:

    • COMPLETE :

      Cadangan selesai.

    • ARCHIVING :

      Sedang diarsipkan di latar belakang.

    • PARTIAL_COMPLETE :

      Cadangan sebagian selesai.

    COMPLETE
    StorageClass

    string

    Kelas penyimpanan.

    Valid values:

    • ARCHIVE :

      Penyimpanan arsip.

    • STANDARD :

      Penyimpanan standar.

    STANDARD
    TableName

    string

    Nama tabel data di instans Tablestore.

    table2
    VaultId

    string

    ID vault yang menyimpan data cadangan.

    v-00030j*******sn
    Success

    boolean

    Apakah permintaan berhasil. Nilai valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true
    TotalCount

    integer

    Jumlah total rekaman.

    3

    Contoh

    Respons sukses

    JSONformat

    {
  "Code": "200",
  "MaxResults": 10,
  "Message": "successful",
  "NextToken": "aWQj********MCMy",
  "RequestId": "17189276-****-****-****-0FF51B5A41A0",
  "Snapshots": [
    {
      "ActualBytes": 600,
      "ActualItems": 6,
      "ArchiveTime": 1640334062,
      "BackupType": "COMPLETE",
      "BytesDone": 800,
      "BytesTotal": 1000,
      "ClientId": "c-*********************",
      "CompleteTime": 1642496679,
      "CreateTime": 1607436917,
      "CreatedTime": 1642496679,
      "ErrorFile": "temp/report/123456789/job-xxxxxxxxx_failed.zip",
      "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
      "ExpireTime": 1771901707,
      "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
      "InstanceId": "i-*********************",
      "InstanceName": "instancename",
      "ItemsDone": 8,
      "ItemsTotal": 10,
      "JobId": "job-00030j3chkt******2",
      "Path": "/home",
      "Paths": [
        "/home"
      ],
      "PlanId": "po-123***7890",
      "ProtectedDataSize": 42949672960,
      "RangeEnd": 1642521709966,
      "RangeStart": 1642492553038,
      "Retention": 7,
      "SnapshotHash": "f2ac5fd243**********************bc4451777be019",
      "SnapshotId": "s-00047mxg17p26*****b",
      "SourceType": "ECS_FILE",
      "Status": "COMPLETE",
      "StorageClass": "STANDARD",
      "TableName": "table2",
      "VaultId": "v-00030j*******sn"
    }
  ],
  "Success": true,
  "TotalCount": 3
}

    Kode kesalahan

    Lihat Error Codes untuk daftar lengkap.

    Catatan rilis

    Lihat Release Notes untuk daftar lengkap.