DescribeSnapshotGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengambil informasi mengenai satu atau beberapa grup konsisten snapshot, seperti status, ID instans, dan progres pembuatan snapshot.

Deskripsi operasi

InstanceId, SnapshotGroupId.N, dan Status.N bukan parameter permintaan wajib, tetapi dapat digunakan untuk membangun logika filter. Parameter-parameter tersebut memiliki hubungan logis AND.

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:DescribeSnapshotGroups

get

SnapshotGroup.

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

SnapshotGroup.

acs:ecs:{#regionId}:{#accountId}:snapshotgroup/{#snapshotgroupId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk menanyakan daftar wilayah terbaru.	cn-hangzhou
InstanceId	string	No	ID instans.	i-j6ca469urv8ei629****
Name	string	No	Nama grup konsisten snapshot.	testName
NextToken	string	No	Token paginasi. Atur parameter ini ke nilai NextToken yang dikembalikan dalam pemanggilan API sebelumnya.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	Jumlah maksimum entri per halaman dalam kueri berbasis paginasi. Nilai maksimum: 100. Nilai default: 10.	10
SnapshotGroupId	array	No	ID grup konsisten snapshot. Nilai N yang valid: 1 hingga 10.	ssg-j6ciyh3k52qp7ovm****
	string	No	ID grup konsisten snapshot. Nilai N yang valid: 1 hingga 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	No	Status grup konsisten snapshot. Nilai N yang valid: 1 hingga 3. Nilai yang valid: progressing: Grup konsisten snapshot sedang dibuat. accomplished: Grup konsisten snapshot telah dibuat. failed: Pembuatan grup konsisten snapshot gagal.	accomplished.
	string	No	Status grup konsisten snapshot. Nilai N yang valid: 1 hingga 3. Nilai yang valid: progressing: Grup konsisten snapshot sedang dibuat. accomplished: Grup konsisten snapshot telah dibuat. failed: Pembuatan grup konsisten snapshot gagal.	accomplished
AdditionalAttributes	array	No	Parameter ini tidak tersedia untuk umum.	hide.
	string	No	Catatan Parameter ini tidak tersedia untuk umum.	null
Tag	array<object>	No	Pasangan kunci-nilai tag dari grup konsisten snapshot.
	object	No	Pasangan kunci-nilai tag dari grup konsisten snapshot.
Key	string	No	Kunci tag dari grup konsisten snapshot. Nilai N yang valid: 1 hingga 20.	TestKey
Value	string	No	Nilai tag dari grup konsisten snapshot. Nilai N yang valid: 1 hingga 20.	TestValue
ResourceGroupId	string	No	ID kelompok sumber daya tempat grup konsisten snapshot berada.	rg-bp67acfmxazb4p****

Elemen respons

Element	Type	Description	Example
	object
NextToken	string	Token paginasi untuk kueri berikutnya. Catatan Jika parameter ini kosong, tidak ada hasil tambahan yang tersedia.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	ID permintaan.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	Informasi tentang grup konsisten snapshot.
	array<object>	Detail grup konsisten snapshot.
SnapshotGroupId	string	ID grup konsisten snapshot.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	ID instans dari grup konsisten snapshot. Parameter ini hanya dikembalikan jika semua snapshot disk dalam grup konsisten snapshot berasal dari instans yang sama. Jika snapshot disk dalam grup konsisten snapshot berasal dari instans ECS yang berbeda, Anda dapat menggunakan parameter `Snapshots.Snapshot.Tags.*` dalam respons untuk menanyakan ID instans masing-masing snapshot dalam grup tersebut.	i-j6ca469urv8ei629****
Status	string	Status grup konsisten snapshot. Nilai yang valid: progressing: sedang dibuat. accomplished: telah dibuat. failed: gagal dibuat.	accomplished
ProgressStatus	string	Catatan Parameter ini tidak tersedia untuk umum.	null
Name	string	Nama grup konsisten snapshot.	testName
Description	string	Deskripsi.	This is description.
CreationTime	string	Waktu pembuatan. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.	2021-03-23T10:58:48Z
ResourceGroupId	string	ID kelompok sumber daya tempat grup konsisten snapshot berada.	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	Pasangan kunci-nilai tag dari grup konsisten snapshot.
	object
Key	string	Kunci tag dari grup konsisten snapshot.	TestKey
Value	string	Nilai tag dari grup konsisten snapshot.	TestValue
Snapshots	object
Snapshot	array<object>	Informasi tentang snapshot dalam grup konsisten snapshot.
	array<object>
SnapshotId	string	ID snapshot.	s-j6cbzmrlbf09w72q****
SourceDiskId	string	ID disk sumber. Bidang ini tetap dipertahankan meskipun disk sumber snapshot telah dilepas.	d-j6c3ogynmvpi6wy7****
SourceDiskType	string	Jenis disk sumber. Nilai yang valid: system: sistem disk. data: data disk.	system
Available	boolean	Menunjukkan apakah snapshot dapat digunakan untuk membuat disk, rollback disk, atau berbagi snapshot. Nilai yang valid: true: tersedia. false: tidak tersedia.	false
Progress	string	Progres pembuatan snapshot, dalam persentase.	100%
InstantAccess	boolean	Menunjukkan apakah fitur akses instans snapshot diaktifkan. Nilai yang valid: true: diaktifkan. Fitur ini diaktifkan secara default untuk disk SSD Perusahaan. false: dinonaktifkan. Snapshot ini adalah snapshot Standar tanpa fitur akses instans diaktifkan. Catatan Parameter ini sudah tidak digunakan lagi. Snapshot Standar dari disk SSD Perusahaan telah ditingkatkan menjadi akses instans diaktifkan secara default. Tidak diperlukan konfigurasi atau biaya tambahan.	true
InstantAccessRetentionDays	integer	Periode retensi fitur akses instans snapshot. Setelah periode retensi berakhir, snapshot akan mengalami pelepasan otomatis. Catatan Parameter ini sudah tidak digunakan lagi. Snapshot Standar dari disk SSD Perusahaan telah ditingkatkan menjadi akses instans diaktifkan secara default. Tidak diperlukan konfigurasi atau biaya tambahan.	3
Tags	object
Tag	array<object>	Pasangan kunci-nilai tag dari setiap snapshot dalam grup konsisten snapshot. Secara default, informasi sumber snapshot disertakan.
	object
Key	string	Kunci tag dari setiap snapshot dalam grup konsisten snapshot. Nilai default Key dan Value berisi informasi sumber snapshot.	acs:ecs:createFrom
Value	string	Nilai tag dari setiap snapshot dalam grup konsisten snapshot. Nilai default Key dan Value berisi informasi sumber snapshot.	i-bp11qm0o3dk4iuc****

Contoh

Respons sukses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A",
  "SnapshotGroups": {
    "SnapshotGroup": [
      {
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Status": "accomplished",
        "ProgressStatus": "null",
        "Name": "testName",
        "Description": "This is description.",
        "CreationTime": "2021-03-23T10:58:48Z",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Tags": {
          "Tag": [
            {
              "Key": "TestKey",
              "Value": "TestValue"
            }
          ]
        },
        "Snapshots": {
          "Snapshot": [
            {
              "SnapshotId": "s-j6cbzmrlbf09w72q****",
              "SourceDiskId": "d-j6c3ogynmvpi6wy7****",
              "SourceDiskType": "system",
              "Available": false,
              "Progress": "100%",
              "InstantAccess": true,
              "InstantAccessRetentionDays": 3,
              "Tags": {
                "Tag": [
                  {
                    "Key": "acs:ecs:createFrom",
                    "Value": "i-bp11qm0o3dk4iuc****"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Terdapat kunci duplikat dalam tag. Pastikan kunci unik.
403	InvalidSnapshotGroupId.MustBeOne	The size of SnapshotGroupIds must be one when AdditionalAttributes has SNAPSHOT_GROUP_PROGRESS_STATUS.
403	InvalidStatus.ValueNotSupported	The specified parameter status is not valid. The expected status is progressing; accomplished or failed.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Informasi wilayah tidak valid.
404	InvalidInstanceId.NotFound	The InstanceId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.