DescribeSnapshotGroups - Elastic Compute Service - Alibaba Cloud Documentation Center

Mengkueri informasi satu atau beberapa kelompok konsisten Snapshot, seperti status, ID Instans tempat kelompok berada, dan progres pembuatan Snapshot.

Deskripsi operasi

InstanceId, SnapshotGroupId.N, dan Status.N bukan parameter permintaan yang wajib, tetapi dapat digunakan untuk membangun logika filter. Hubungan antarparameter adalah logika 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 mengkueri daftar wilayah Alibaba Cloud terbaru.	cn-hangzhou
InstanceId	string	No	ID instans.	i-j6ca469urv8ei629****
Name	string	No	Nama kelompok konsisten Snapshot.	testName
NextToken	string	No	Token kueri. Atur nilai ke nilai NextToken yang dikembalikan dalam pemanggilan sebelumnya.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	Jumlah entri per halaman. Nilai maksimum: 100. Nilai default: 10.	10
SnapshotGroupId	array	No	ID kelompok konsisten Snapshot. Nilai valid untuk N: 1 hingga 10.	ssg-j6ciyh3k52qp7ovm****
	string	No	ID kelompok konsisten Snapshot. Nilai valid untuk N: 1 hingga 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	No	Status kelompok konsisten Snapshot. Nilai valid untuk N: 1 hingga 3. Nilai valid: progressing: Kelompok konsisten Snapshot sedang dibuat. accomplished: Kelompok konsisten Snapshot telah dibuat. failed: Gagal membuat kelompok konsisten Snapshot.	accomplished
	string	No	Status kelompok konsisten Snapshot. Nilai valid untuk N: 1 hingga 3. Nilai valid: progressing: Kelompok konsisten Snapshot sedang dibuat. accomplished: Kelompok konsisten Snapshot telah dibuat. failed: Gagal membuat kelompok konsisten Snapshot.	accomplished
AdditionalAttributes	array	No	Parameter ini tidak tersedia untuk penggunaan publik.	hide
	string	No	Catatan Parameter ini tidak tersedia untuk penggunaan publik.	null
Tag	array<object>	No	Tag kelompok konsisten Snapshot.
	object	No	Tag kelompok konsisten Snapshot.
Key	string	No	Kunci tag kelompok konsisten Snapshot. Nilai valid untuk N: 1 hingga 20.	TestKey
Value	string	No	Nilai tag kelompok konsisten Snapshot. Nilai valid untuk N: 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 yang digunakan untuk memulai kueri berikutnya. Catatan Jika nilai ini kosong, tidak ada data lagi yang dikembalikan.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	ID permintaan.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	Array yang terdiri dari informasi kelompok konsisten Snapshot.
	array<object>
Status	string	The state of the snapshot-consistent group. Valid values: progressing: The snapshot-consistent group was being created. accomplished: The snapshot-consistent group was created. failed: The snapshot-consistent group failed to be created.	accomplished
CreationTime	string	The creation time. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-03-23T10:58:48Z
Description	string	The description of the snapshot-consistent group.	This is description.
ProgressStatus	string	Catatan This parameter is not publicly available.	null
SnapshotGroupId	string	The ID of the snapshot-consistent group.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	The ID of the instance to which the snapshot-consistent group belongs. This parameter has a value only when all disk snapshots in the snapshot-consistent group belong to the same instance. If disk snapshots in the snapshot-consistent group belong to different instances, you can check the response parameters that start with `Snapshots.Snapshot.Tags.` to determine the ID of the instance to which each snapshot in the snapshot-consistent group belongs.	i-j6ca469urv8ei629****
Name	string	The name of the snapshot-consistent group.	testName
ResourceGroupId	string	The ID of the resource group to which the snapshot-consistent group belongs.	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	The tags of the snapshot-consistent group.
	object
Key	string	The tag key of the snapshot-consistent group.	TestKey
Value	string	The tag value of the snapshot-consistent group.	TestValue
Snapshots	object
Snapshot	array<object>	The information about the snapshots in the snapshot-consistent group.
	array<object>
SourceDiskId	string	The ID of the source disk. This parameter is retained even after the source disk of the snapshot is released.	d-j6c3ogynmvpi6wy7****
Progress	string	The progress of the snapshot creation task. Unit: percent (%).	100%
Available	boolean	Indicates whether the snapshot can be shared and be used to create or roll back a disk. Valid values: true false	false
InstantAccessRetentionDays	integer	The validity period of the instant access feature. When the validity period ends, the instant access snapshot is automatically released. Catatan This parameter is no longer used. By default, standard snapshots of ESSDs are upgraded to instant access snapshots free of charge without the need for additional configurations. For more information, see Use the instant access feature.	3
SnapshotId	string	The ID of the snapshot.	s-j6cbzmrlbf09w72q****
InstantAccess	boolean	Indicates whether the instant access feature is enabled. Valid values: true: The instant access feature is enabled. By default, the instant access feature is enabled for ESSDs. false: The instant access feature is disabled. The snapshot is a standard snapshot for which the instant access feature is disabled. Catatan This parameter is no longer used. By default, standard snapshots of ESSDs are upgraded to instant access snapshots free of charge without the need for additional configurations. For more information, see Use the instant access feature.	true
SourceDiskType	string	The type of the source disk. Valid values: system: system disk data: data disk	system
Tags	object
Tag	array<object>	The tags of the snapshot. The default values contain snapshot source information.
	object
Key	string	The tag key of the snapshot. The default values of Key and Value contain snapshot source information.	acs:ecs:createFrom
Value	string	The tag value of the snapshot. The default values of Key and Value contain snapshot source information.	i-bp11qm0o3dk4iuc****

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
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.
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.