DescribeSnapshots - - Alibaba Cloud Documentation Center

Mengambil semua snapshot dari instans Elastic Compute Service (ECS) atau disk.

Catatan Penggunaan

Anda dapat menentukan beberapa parameter permintaan, seperti InstanceId, DiskId, dan SnapshotIds, yang akan ditanyakan. Parameter yang ditentukan memiliki hubungan logika AND—hanya parameter yang ditentukan yang digunakan sebagai kondisi filter.

Saat menggunakan Alibaba Cloud CLI untuk memanggil operasi API, Anda harus menentukan nilai parameter permintaan dengan tipe data berbeda dalam format yang sesuai. Untuk informasi selengkapnya, lihat Ikhtisar format parameter.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi untuk berbagai SDK.

Parameter Permintaan

Parameter	Tipe	Diperlukan	Contoh	Deskripsi
Action	String	Ya	DescribeSnapshots	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DescribeSnapshots.
InstanceId	String	Tidak	i-bp67acfmxazb4p****	ID instans.
DiskId	String	Tidak	d-bp67acfmxazb4p****	ID disk.
SnapshotLinkId	String	Tidak	sl-bp1grgphbcc9brb5****	ID rantai snapshot.
RegionId	String	Ya	cn-hangzhou	ID wilayah disk. Anda dapat memanggil operasi DescribeRegions untuk menanyakan daftar wilayah terbaru.
SnapshotIds	String	Tidak	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", ... "s-bp67acfmxazb6p**"]	ID snapshot. Nilainya dapat berupa array JSON yang terdiri dari maksimal 100 ID snapshot. Pisahkan ID snapshot dengan koma (,).
PageNumber	Integer	Tidak	1	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.
PageSize	Integer	Tidak	10	Jumlah entri per halaman. Nilai maksimum: 100. Nilai default: 10.
NextToken	String	Tidak	caeba0bbb2be03f84eb48b699f0a4883	Token paginasi yang digunakan dalam permintaan ini untuk mengambil halaman hasil baru. Anda tidak perlu menentukan parameter ini untuk permintaan pertama. Anda harus menentukan token yang diperoleh dari kueri sebelumnya sebagai nilai NextToken.
MaxResults	Integer	Tidak	10	Jumlah maksimum entri per halaman. Nilai maksimum: 100. Nilai default: 10.
SnapshotName	String	Tidak	testSnapshotName	Nama snapshot.
Status	String	Tidak	all	Status snapshot. Nilai yang valid: progressing: Snapshot sedang dibuat. accomplished: Snapshot telah dibuat. failed: Pembuatan snapshot gagal. all (default): Nilai ini menunjukkan semua status snapshot.
SnapshotType	String	Tidak	all	Tipe snapshot. Nilai yang valid: auto: automatic snapshot user: manual snapshot all (default): semua tipe snapshot
Filter.1.Key	String	Tidak	CreationStartTime	Kunci filter 1 yang digunakan untuk menanyakan resource. Tetapkan nilainya ke `CreationStartTime`. Anda dapat menetapkan waktu dengan menentukan `Filter.1.Key` dan `Filter.1.Value` untuk menanyakan resource yang dibuat setelah waktu tersebut.
Filter.2.Key	String	Tidak	CreationEndTime	Kunci filter 2 yang digunakan untuk menanyakan resource. Tetapkan nilainya ke `CreationEndTime`. Anda dapat menentukan waktu dengan menetapkan `Filter.2.Key` dan `Filter.2.Value` untuk menanyakan resource yang dibuat sebelum waktu tersebut.
Filter.1.Value	String	Tidak	2019-12-13T17:00Z	Nilai filter 1 yang digunakan untuk menanyakan resource. Tetapkan nilainya ke waktu tertentu. Jika Anda menentukan parameter ini, Anda juga harus menentukan `Filter.1.Key`. Tentukan waktu dalam format `yyyy-MM-ddTHH:mmZ`. Waktu harus dalam UTC.
Filter.2.Value	String	Tidak	2019-12-13T22:00Z	Nilai filter 2 yang digunakan untuk menanyakan resource. Tetapkan nilainya ke waktu tertentu. Jika Anda menentukan parameter ini, Anda juga harus menentukan `Filter.2.Key`. Tentukan waktu dalam format `yyyy-MM-ddTHH:mmZ`. Waktu harus dalam UTC.
Usage	String	Tidak	none	Menentukan apakah snapshot telah digunakan untuk membuat gambar atau disk. Nilai yang valid: image: Snapshot telah digunakan untuk membuat custom image. disk: Snapshot telah digunakan untuk membuat disk. image_disk: Snapshot telah digunakan untuk membuat custom image dan data disk. none: Snapshot belum digunakan untuk membuat gambar atau disk.
SourceDiskType	String	Tidak	Data	Tipe disk sumber snapshot. Nilai yang valid: system: system disk data: data disk Catatan Nilai parameter ini tidak peka huruf besar/kecil.
Encrypted	Boolean	Tidak	false	Menentukan apakah snapshot dienkripsi. Nilai default: false.
ResourceGroupId	String	Tidak	rg-bp67acfmxazb4p****	ID kelompok sumber daya tempat snapshot berada. Jika parameter ini ditentukan untuk menanyakan resource, maksimal 1.000 resource yang termasuk dalam kelompok sumber daya tersebut akan dikembalikan. Catatan Resource dalam kelompok sumber daya default akan ditampilkan dalam respons terlepas dari cara parameter ini diatur.
DryRun	Boolean	Tidak	false	Menentukan apakah hanya menjalankan dry run tanpa melakukan permintaan aktual. Nilai yang valid: true: hanya menjalankan dry run. Sistem memeriksa Pasangan Kunci Akses, izin Pengguna RAM, dan parameter yang diperlukan. Jika permintaan gagal dalam dry run, pesan kesalahan akan dikembalikan. Jika permintaan lolos dry run, kode kesalahan DryRunOperation akan dikembalikan. false (default): menjalankan dry run dan melakukan permintaan aktual. Jika permintaan lolos dry run, kode status HTTP 2xx akan dikembalikan dan operasi dilakukan.
KMSKeyId	String	Tidak	0e478b7a-4262-4802-b8cb-00d3fb40****	ID kunci Key Management Service (KMS) yang digunakan oleh data disk.
Category	String	Tidak	Standard	Kategori snapshot. Nilai yang valid: Standard: normal snapshot Flash: local snapshot Fitur local snapshot telah digantikan oleh fitur instant access. Saat Anda menentukan parameter ini, perhatikan hal-hal berikut: Jika Anda pernah menggunakan local snapshot sebelum 14 Desember 2020, Anda dapat menggunakan parameter ini. Jika Anda belum pernah menggunakan local snapshot sebelum 14 Desember 2020, Anda tidak dapat menggunakan parameter ini. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan parameter lain untuk memastikan kompatibilitas di masa depan.
Tag.N.key	String	Tidak	SnapshotTest	Kunci tag N snapshot. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan parameter Tag.N.Key untuk memastikan kompatibilitas di masa depan.
Tag.N.Key	String	Tidak	TestKey	Kunci tag N snapshot. Nilai N yang valid: 1 hingga 20. Jika satu tag ditentukan untuk menanyakan resource, maksimal 1.000 resource yang memiliki tag tersebut akan dikembalikan. Jika beberapa tag ditentukan untuk menanyakan resource, maksimal 1.000 resource yang memiliki semua tag tersebut akan dikembalikan. Untuk menanyakan lebih dari 1.000 resource yang memiliki tag yang ditentukan, panggil operasi ListTagResources.
Tag.N.Value	String	Tidak	TestValue	Nilai tag N snapshot. Nilai N yang valid: 1 hingga 20.
Tag.N.value	String	Tidak	SnapshotTest	Nilai tag N snapshot. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan Tag.N.Value untuk memastikan kompatibilitas di masa depan.

Parameter Respons

Parameter	Tipe	Contoh	Deskripsi
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Token paginasi. Dapat digunakan dalam permintaan berikutnya untuk mengambil halaman hasil baru.
PageSize	Integer	10	Jumlah entri per halaman.
PageNumber	Integer	1	Nomor halaman.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID permintaan.
TotalCount	Integer	1	Jumlah total snapshot yang dikembalikan.
Snapshots	Array of Snapshot		Detail tentang snapshot.
Snapshot
Status	String	accomplished	Status snapshot. Nilai yang valid: progressing accomplished failed
CreationTime	String	2020-08-20T14:52:28Z	Waktu saat snapshot dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.
Progress	String	100%	Progres tugas pembuatan snapshot. Satuan: persen (%).
InstantAccess	Boolean	false	Menunjukkan apakah fitur instant access diaktifkan. Nilai yang valid: true: Fitur instant access diaktifkan. Fitur ini hanya dapat diaktifkan untuk enhanced SSD (ESSD). false: Fitur instant access dinonaktifkan. Snapshot adalah normal snapshot yang fitur instant access-nya dinonaktifkan.
Available	Boolean	false	Menunjukkan apakah snapshot dapat digunakan untuk membuat atau melakukan rollback disk. Nilai yang valid: true: Snapshot dapat digunakan untuk membuat atau melakukan rollback disk. false: Snapshot tidak dapat digunakan untuk membuat atau melakukan rollback disk.
RemainTime	Integer	38	Sisa waktu yang diperlukan untuk membuat snapshot. Satuan: detik.
SourceDiskSize	String	40	Kapasitas disk sumber. Satuan: GiB.
RetentionDays	Integer	30	Periode retensi snapshot otomatis.
SourceDiskType	String	system	Tipe disk sumber. Nilai yang valid: system data
SourceStorageType	String	disk	Tipe disk sumber. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan parameter lain untuk memastikan kompatibilitas di masa depan.
Usage	String	image	Menunjukkan apakah snapshot telah digunakan untuk membuat gambar atau disk. Nilai yang valid: image disk image_disk none
LastModifiedTime	String	2020-08-25T14:18:09Z	Waktu saat snapshot terakhir dimodifikasi. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.
Encrypted	Boolean	false	Menunjukkan apakah snapshot dienkripsi.
SnapshotType	String	all	Tipe snapshot. Nilai yang valid: auto atau timer: automatic snapshot user: manual snapshot all: semua tipe snapshot
SourceDiskId	String	d-bp67acfmxazb4ph****	ID disk sumber. Parameter ini tetap dipertahankan bahkan setelah disk sumber tempat snapshot dibuat telah dilepas.
SnapshotName	String	testSnapshotName	Nama snapshot. Parameter ini hanya dikembalikan jika nama snapshot ditentukan saat snapshot dibuat.
InstantAccessRetentionDays	Integer	30	Durasi fitur instant access. Fitur instant access akan dinonaktifkan secara otomatis ketika durasi yang ditentukan berakhir. Secara default, nilai parameter ini sama dengan nilai `RetentionDays`.
Description	String	testDescription	Deskripsi snapshot.
SnapshotId	String	s-bp67acfmxazb4p****	ID snapshot.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID kelompok sumber daya.
Category	String	standard	Kategori snapshot. Catatan Parameter ini akan dihapus di masa mendatang. Kami menyarankan agar Anda menggunakan parameter `InstantAccess` untuk memastikan kompatibilitas di masa depan.
KMSKeyId	String	0e478b7a-4262-4802-b8cb-00d3fb40****	ID kunci KMS yang digunakan oleh data disk.
SnapshotSN	String	64472-116742336-61976****	Nomor seri snapshot.
ProductCode	String	jxsc000****	Kode produk gambar Alibaba Cloud Marketplace.
SourceSnapshotId	String	s-bp67acfmxazb4p****	ID snapshot sumber.
SourceRegionId	String	cn-hangzhou	ID wilayah snapshot sumber.
Tags	Array of Tag		Tag snapshot.
Tag
TagValue	String	TestValue	Nilai tag snapshot.
TagKey	String	TestKey	Kunci tag snapshot.

Contoh

Permintaan Contoh

https://ecs.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&InstanceId=i-bp67acfmxazb4p****
&DiskId=d-bp67acfmxazb4p****
&SnapshotIds=["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", ... "s-bp67acfmxazb6p****"]
&PageNumber=1
&PageSize=10
&SnapshotName=testSnapshotName
&Status=all
&SnapshotType=all
&Usage=none
&SourceDiskType=Data
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&Encrypted=false
&DryRun=false
&<Common request parameters>

Respons Sukses Contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSnapshotsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>10</PageSize>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <PageNumber>1</PageNumber>
    <Snapshots>
        <Snapshot>
            <Status>accomplished</Status>
            <InstantAccess>false</InstantAccess>
            <Progress>100%</Progress>
            <Available>false</Available>
            <Usage>image</Usage>
            <Description>testDescription</Description>
            <Category>standard</Category>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
            <ProductCode>jxsc000****</ProductCode>
            <Encrypted>false</Encrypted>
            <SnapshotName>testSnapshotName</SnapshotName>
            <SourceDiskId>d-bp67acfmxazb4ph****</SourceDiskId>
            <SourceStorageType>disk</SourceStorageType>
            <SnapshotId>s-bp67acfmxazb4p****</SnapshotId>
            <SnapshotSN>64472-116742336-61976****</SnapshotSN>
            <SourceDiskSize>40</SourceDiskSize>
            <CreationTime>2020-08-20T14:52:28Z</CreationTime>
            <LastModifiedTime>2020-08-25T14:18:09Z</LastModifiedTime>
            <SnapshotType>all</SnapshotType>
            <SourceDiskType>system</SourceDiskType>
            <Tags>
            </Tags>
        </Snapshot>
    </Snapshots>
</DescribeSnapshotsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Kode Kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	Nilai Tag.N.Key dan Tag.N.Value tidak sesuai satu sama lain.
400	InvalidTagCount	The specified tags are beyond the permitted range.	Jumlah maksimum tag telah terlampaui.
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.	Format SnapshotIds tidak valid.
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	Nilai Category tidak valid.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.	Kunci filter tidak ditemukan.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.	Nilai filter tidak valid.
404	InvalidUsage	The specifed Usage is not valid.	Nilai Usage tidak valid.
404	InvalidStatus.NotFound	The specified Status is not found.	Nilai Status tidak valid.
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.	Nilai SnapshotLinkId tidak ditemukan.
500	InternalError	The request processing has failed due to some unknown error.	Terjadi kesalahan internal. Coba lagi nanti.

Untuk daftar kode kesalahan, lihat Kode Kesalahan Layanan.