DescribeSnapshots - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri daftar snapshot cloud disk, seperti status snapshot, waktu tersisa untuk pembuatan snapshot, dan hari retensi snapshot otomatis.

Deskripsi operasi

InstanceId, DiskId, dan SnapshotIds bukan parameter permintaan yang wajib, tetapi Anda dapat menggunakannya untuk membangun logika filter. Parameter-parameter ini dievaluasi dengan hubungan logika AND.

Saat Anda memanggil operasi ini menggunakan Asisten Cloud CLI, parameter permintaan dengan tipe data berbeda harus mengikuti persyaratan format tertentu. Untuk detail, lihat Format parameter CLI.

Contoh permintaan:

Mengkueri daftar snapshot semua disk dari Instans ECS di wilayah China (Hangzhou)

RegionId:  ap-southeast-1,   //Tentukan wilayah.
InstanceId:  i-bp1fh7by6d9mw7zr****   //Tentukan ID instans yang akan dikueri.

Mengkueri informasi snapshot disk tertentu di wilayah China (Hangzhou)

RegionId:  ap-southeast-1,   //Tentukan wilayah.
DiskId:   d-bp10e7ej8z743dmu****   //Tentukan ID disk yang akan dikueri.

Mengkueri informasi dua snapshot di wilayah China (Hangzhou) berdasarkan ID snapshot

RegionId:  ap-southeast-1,   //Tentukan wilayah.
SnapshotIds:   ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"]   //Tentukan array ID snapshot yang akan dikueri.

Mengkueri informasi snapshot yang dibuat setelah titik waktu tertentu di wilayah China (Hangzhou)

RegionId:  ap-southeast-1,   //Tentukan wilayah.
Filter.1.Key:   CreationStartTime,   //Tentukan kunci filter untuk waktu mulai pembuatan.
Filter.1.Value:   2024-11-27T00:00Z.

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

ecs:DescribeSnapshots

get

Snapshot

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

Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	No	ID instans. Tentukan parameter ini untuk mengkueri informasi snapshot disk yang terpasang pada instans tertentu.	i-bp67acfmxazb4p****
DiskId	string	No	ID disk.	d-bp67acfmxazb4p****
SnapshotLinkId	string	No	ID rantai snapshot.	sl-bp1grgphbcc9brb5****
RegionId	string	Yes	ID wilayah disk. Anda dapat memanggil DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
SnapshotIds	string	No	ID snapshot. Nilai berupa array JSON yang terdiri dari hingga 100 ID snapshot. Pisahkan ID dengan koma (,).	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]
PageNumber	integer	No	Catatan Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk operasi kueri penomoran halaman.	1
PageSize	integer	No	Catatan Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk operasi kueri penomoran halaman.	10
NextToken	string	No	Token penomoran halaman. Diperoleh dari tanggapan permintaan sebelumnya.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	Jumlah entri maksimum per halaman untuk kueri penomoran halaman. Nilai maksimum: 100. Nilai default: 10.	10
SnapshotName	string	No	Nama snapshot.	testSnapshotName
Status	string	No	Status snapshot. Nilai valid: progressing: Snapshot sedang dibuat. accomplished: Snapshot telah dibuat. failed: Snapshot gagal dibuat. all (default): semua status snapshot.	all
SnapshotType	string	No	Tipe pembuatan otomatis. Nilai valid: auto: snapshot otomatis. user: snapshot manual. all (default): semua tipe pembuatan otomatis.	all
Filter.1.Key	string	No	Kunci filter yang digunakan untuk mengkueri resource. Atur nilai menjadi `CreationStartTime`. Saat Anda menentukan `Filter.1.Key` dan `Filter.1.Value`, Anda dapat mengkueri resource yang dibuat setelah titik waktu tertentu.	CreationStartTime
Filter.2.Key	string	No	Kunci filter yang digunakan untuk mengkueri resource. Atur nilai menjadi `CreationEndTime`. Saat Anda menentukan `Filter.2.Key` dan `Filter.2.Value`, Anda dapat mengkueri resource yang dibuat sebelum titik waktu tertentu.	CreationEndTime
Filter.1.Value	string	No	Nilai filter yang digunakan untuk mengkueri resource. Saat Anda menentukan parameter ini, Anda juga harus menentukan `Filter.1.Key`. Tentukan waktu dalam format `yyyy-MM-ddTHH:mmZ` UTC.	2019-12-13T17:00Z
Filter.2.Value	string	No	Nilai filter yang digunakan untuk mengkueri resource. Saat Anda menentukan parameter ini, Anda juga harus menentukan `Filter.2.Key`. Tentukan waktu dalam format `yyyy-MM-ddTHH:mmZ` UTC.	2019-12-13T22:00Z
Usage	string	No	Apakah snapshot telah digunakan untuk membuat image atau disk. Nilai valid: image: Snapshot telah digunakan untuk membuat gambar kustom. disk: Snapshot telah digunakan untuk membuat disk. image_disk: Snapshot telah digunakan untuk membuat disk data dan gambar kustom. none: Snapshot belum digunakan.	none
SourceDiskType	string	No	Tipe disk sumber. Nilai valid: system: disk sistem. data: disk data. Catatan Nilai tidak peka huruf besar/kecil.	system
Encrypted	boolean	No	Apakah akan memfilter snapshot terenkripsi. Nilai default: false.	false
ResourceGroupId	string	No	ID kelompok sumber daya. Saat Anda menggunakan parameter ini untuk memfilter resource, jumlah resource tidak boleh melebihi 1000. Catatan Pemfilteran berdasarkan kelompok sumber daya default tidak didukung.	rg-bp67acfmxazb4p****
DryRun	boolean	No	Apakah akan menjalankan dry run saja, tanpa menjalankan permintaan aktual. true: Mengirim permintaan pemeriksaan tanpa mengkueri status resource. Item pemeriksaan mencakup apakah AccessKey Anda valid, apakah otorisasi pengguna Resource Access Management (RAM) valid, dan apakah parameter yang diperlukan telah ditentukan. Jika pemeriksaan gagal, error yang sesuai akan dikembalikan. Jika pemeriksaan berhasil, kode kesalahan DryRunOperation akan dikembalikan. false (default): Mengirim permintaan normal. Setelah pemeriksaan berhasil, kode status HTTP 2xx akan dikembalikan dan status resource akan dikueri.	false
KMSKeyId	string	No	ID kunci Key Management Service (KMS) yang digunakan oleh disk data.	0e478b7a-4262-4802-b8cb-00d3fb40****
Category	string	No	Kategori snapshot. Nilai valid: Standard: Snapshot normal. Flash: snapshot lokal. Nilai ini akan segera dihentikan penggunaannya. Snapshot lokal telah digantikan oleh fitur akses instan snapshot. Deskripsi metrik adalah sebagai berikut: Jika Anda menggunakan snapshot lokal sebelum 14 Desember 2020, Anda dapat menggunakan parameter ini karena masih aktif. Jika Anda tidak menggunakan snapshot lokal sebelum 14 Desember 2020, Anda tidak dapat menggunakan parameter ini. archive: snapshot arsip.	Standard
Tag	array<object>	No	Tag.
	object	No
key	string	No	Kunci tag resource. Catatan Untuk kompatibilitas yang lebih baik, gunakan Tag.N.Key.	SnapshotTest
Key	string	No	Kunci tag snapshot. Nilai valid N: 1 hingga 20. Jika Anda menggunakan satu tag untuk memfilter resource, jumlah resource dengan tag tertentu tidak boleh melebihi 1000. Jika Anda menggunakan beberapa tag untuk memfilter resource, jumlah resource dengan semua tag tertentu yang terpasang tidak boleh melebihi 1000. Jika jumlah resource melebihi 1000, panggil operasi ListTagResources.	TestKey
Value	string	No	Nilai tag snapshot. Nilai valid N: 1 hingga 20.	TestValue
value	string	No	Nilai tag resource. Catatan Untuk kompatibilitas yang lebih baik, gunakan Tag.N.Value.	SnapshotTest

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token penomoran halaman untuk kueri berikutnya.	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	Catatan Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk operasi kueri penomoran halaman.	10
PageNumber	integer	Catatan Parameter ini akan segera dihentikan penggunaannya. Gunakan NextToken dan MaxResults untuk operasi kueri penomoran halaman.	1
RequestId	string	ID permintaan.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Jumlah total snapshot. Catatan Saat Anda menggunakan parameter `MaxResults` dan `NextToken` untuk kueri penomoran halaman, nilai parameter `TotalCount` yang dikembalikan tidak valid.	1
Snapshots	object
Snapshot	array<object>	Detail snapshot.
	array<object>
Status	string	Status snapshot. Nilai valid: progressing: Snapshot sedang dibuat. accomplished: Snapshot telah dibuat. failed: Gagal membuat snapshot.	accomplished
CreationTime	string	Pengatur waktu pembuatan snapshot. Pengatur waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Pengatur waktu ditampilkan dalam UTC.	2020-08-20T14:52:28Z
Progress	string	Progres tugas pembuatan snapshot, dalam persentase.	100%
InstantAccess	boolean	Apakah fitur akses instan snapshot diaktifkan. Nilai valid: true: diaktifkan. Disk SSD Perusahaan (ESSD) dan disk ESSD Entry memiliki fitur ini diaktifkan secara default. false: dinonaktifkan. Snapshot adalah snapshot Jenis Penyimpanan Standar yang fitur akses instannya tidak diaktifkan. Catatan Parameter ini tidak digunakan lagi. Snapshot standar untuk SSD standar telah Peningkatan menjadi akses instan secara default. Tidak diperlukan konfigurasi atau biaya tambahan.	false
Available	boolean	Apakah snapshot dapat digunakan untuk membuat disk, melakukan rollback disk, atau membagikan snapshot. Nilai valid: true: tersedia. false: tidak tersedia.	false
RemainTime	integer	Pengatur waktu tersisa yang diperlukan untuk membuat snapshot, dalam detik.	38
SourceDiskSize	string	Kapasitas disk sumber. Unit: GiB.	40
RetentionDays	integer	Jumlah hari retensi snapshot otomatis.	30
SourceDiskType	string	Tipe disk sumber. Nilai valid: system data.	system
SourceStorageType	string	Tipe disk sumber. Catatan Parameter ini akan segera ditinggalkan. Untuk kompatibilitas yang lebih baik, gunakan parameter lain sebagai gantinya.	disk
Usage	string	Apakah snapshot telah digunakan untuk membuat gambar kustom atau disk. Nilai valid: image: gambar kustom. disk: disk. image_disk: gambar kustom dan disk data. none: tidak digunakan.	image
LastModifiedTime	string	Pengatur waktu terakhir snapshot diubah. Pengatur waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Pengatur waktu ditampilkan dalam UTC.	2020-08-25T14:18:09Z
Encrypted	boolean	Apakah snapshot terenkripsi. Nilai valid: true: terenkripsi. false: tidak terenkripsi.	false
SnapshotType	string	Tipe pembuatan otomatis. Nilai valid: auto atau pengatur waktu: snapshot otomatis. user: snapshot manual. all: semua tipe pembuatan otomatis.	all
SourceDiskId	string	ID disk sumber. Parameter ini dipertahankan meskipun disk sumber telah dilepas.	d-bp67acfmxazb4ph****
SnapshotName	string	Nama tampilan snapshot. Parameter ini dikembalikan jika nama tampilan ditentukan saat snapshot dibuat.	testSnapshotName
InstantAccessRetentionDays	integer	Periode retensi fitur akses instan snapshot. Setelah periode retensi berakhir, fitur akses instan snapshot dinonaktifkan secara otomatis. Nilai default sama dengan nilai parameter `RetentionDays`. Catatan Parameter ini tidak digunakan lagi. Snapshot standar untuk SSD standar telah Peningkatan menjadi akses instan secara default. Tidak diperlukan konfigurasi atau biaya tambahan.	30
Description	string	Deskripsi snapshot.	testDescription
SnapshotId	string	ID snapshot.	s-bp67acfmxazb4p****
RegionId	string	ID wilayah snapshot.	cn-hangzhou
ResourceGroupId	string	ID kelompok sumber daya.	rg-bp67acfmxazb4p****
Category	string	Kategori snapshot. Nilai valid: Jenis Penyimpanan Standar: snapshot standar. Flash: snapshot lokal. Nilai ini akan segera ditinggalkan. Snapshot lokal telah digantikan oleh fitur akses instan snapshot. archive: snapshot arsip.	standard
KMSKeyId	string	ID kunci Key Management Service (KMS) yang digunakan oleh disk data.	0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSN	string	Nomor seri snapshot.	64472-116742336-61976****
ProductCode	string	Kode produk yang diwarisi dari image Alibaba Cloud Marketplace.	jxsc000****
SourceSnapshotId	string	ID snapshot sumber.	s-bp67acfmxazb4p****
SourceRegionId	string	ID wilayah snapshot sumber.	cn-hangzhou
FullSnapshotSizeInBytes	integer		65535
Tags	object
Tag	array<object>	Tag.
	object
TagValue	string	Nilai tag snapshot.	TestValue
TagKey	string	Kunci tag snapshot.	TestKey
SnapshotLinkId	string	ID rantai snapshot tempat snapshot berada.	sl-bp1grgphbcc9brb5****

Contoh

Respons sukses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "CreationTime": "2020-08-20T14:52:28Z",
        "Progress": "100%",
        "InstantAccess": false,
        "Available": false,
        "RemainTime": 38,
        "SourceDiskSize": "40",
        "RetentionDays": 30,
        "SourceDiskType": "system",
        "SourceStorageType": "disk",
        "Usage": "image",
        "LastModifiedTime": "2020-08-25T14:18:09Z",
        "Encrypted": false,
        "SnapshotType": "all",
        "SourceDiskId": "d-bp67acfmxazb4ph****",
        "SnapshotName": "testSnapshotName",
        "InstantAccessRetentionDays": 30,
        "Description": "testDescription",
        "SnapshotId": "s-bp67acfmxazb4p****",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Category": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "SnapshotSN": "64472-116742336-61976****",
        "ProductCode": "jxsc000****",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "SourceRegionId": "cn-hangzhou",
        "FullSnapshotSizeInBytes": 65535,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SnapshotLinkId": "sl-bp1grgphbcc9brb5****"
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.
400	InvalidTagCount	The specified tags are beyond the permitted range.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.
403	InvalidCategory.SnapshotLinkMismatch	The specified category does not match the actual category of the snapshot link.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.
404	InvalidUsage	The specifed Usage is not valid.
404	InvalidSourceDiskType	The specifed SourceDiskType is not valid.
404	InvalidStatus.NotFound	The specified Status is not found.
404	InvalidSnapshotType.NotFound	The specfied SnapshotType is not found.
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.