DescribeSnapshotGroups - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les informations sur un ou plusieurs groupes de cohérence d'instantanés, telles que l'état, l'identifiant de l'instance et la progression de la création des instantanés.

Description de l'opération

InstanceId, SnapshotGroupId.N et Status.N ne sont pas des paramètres de requête obligatoires, mais vous pouvez les utiliser pour créer une logique de filtrage. Ces paramètres ont une relation ET logique.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ecs:DescribeSnapshotGroups

get

SnapshotGroup.

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

SnapshotGroup.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour obtenir la liste des régions la plus récente.	cn-hangzhou
InstanceId	string	Non	L'identifiant de l'instance.	i-j6ca469urv8ei629****
Name	string	Non	Le nom du groupe de cohérence d'instantanés.	testName
NextToken	string	Non	Le jeton de pagination. Définissez ce paramètre sur la valeur NextToken renvoyée lors de l'appel d'API précédent.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Non	Le nombre maximal d'entrées par page dans une requête paginée.	10
SnapshotGroupId	array	Non	L'identifiant du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 10.	ssg-j6ciyh3k52qp7ovm****
	string	Non	L'identifiant du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 10.	ssg-j6ciyh3k52qp7ovm****
Status	array	Non	L'état du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 3. Valeurs valides :	accomplished
	string	Non	L'état du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 3. Valeurs valides :	accomplished
AdditionalAttributes	array	Non	Ce paramètre n'est pas disponible publiquement.	hide
	string	Non	Remarque Ce paramètre n'est pas disponible publiquement.	null
Tag	array<object>	Non	Les paires clé-valeur de balise du groupe de cohérence d'instantanés.
	object	Non	Les paires clé-valeur de balise du groupe de cohérence d'instantanés.
Key	string	Non	La clé de balise du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 20.	TestKey
Value	string	Non	La valeur de balise du groupe de cohérence d'instantanés. Valeurs valides de N : 1 à 20.	TestValue
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel le groupe de cohérence d'instantanés appartient.	rg-bp67acfmxazb4p****

Éléments de réponse

Élément	Type	Description	Exemple
	object
NextToken	string	Le jeton de pagination pour la requête suivante.	caeba0bbb2be03f84eb48b699f0a4883
RequestId	string	L'identifiant de la requête.	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A
SnapshotGroups	object
SnapshotGroup	array<object>	Les informations sur les groupes de cohérence d'instantanés.
	array<object>	Les détails du groupe de cohérence d'instantanés.
SnapshotGroupId	string	L'identifiant du groupe d'instantanés cohérents.	ssg-j6ciyh3k52qp7ovm****
InstanceId	string	L'identifiant de l'instance à laquelle le groupe d'instantanés cohérents appartient. Ce paramètre n'est renvoyé que lorsque tous les instantanés de disque du groupe d'instantanés cohérents appartiennent à la même instance. Si les instantanés de disque du groupe d'instantanés cohérents appartiennent à différentes instances ECS, vous pouvez vérifier le paramètre Snapshots.Snapshot.Tags.* dans la réponse pour afficher l'identifiant de l'instance de chaque instantané individuel du groupe.	i-j6ca469urv8ei629****
Status	string	L'état du groupe d'instantanés cohérents. Valeurs valides :	accomplished
ProgressStatus	string	Remarque Ce paramètre n'est pas disponible publiquement.	null
Name	string	Le nom du groupe d'instantanés cohérents.	testName
Description	string	La description.	Ceci est une description
CreationTime	string	L'heure de création. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2021-03-23T10:58:48Z
ResourceGroupId	string	L'identifiant du groupe de ressources auquel le groupe d'instantanés cohérents appartient.	rg-bp67acfmxazb4p****
Tags	object
Tag	array<object>	Les paires clé-valeur des balises du groupe d'instantanés cohérents.
	object
Key	string	La clé de balise du groupe d'instantanés cohérents.	TestKey
Value	string	La valeur de balise du groupe d'instantanés cohérents.	TestValue
Snapshots	object
Snapshot	array<object>	Les informations sur les instantanés du groupe d'instantanés cohérents.
	array<object>
SnapshotId	string	L'identifiant de l'instantané.	s-j6cbzmrlbf09w72q****
SourceDiskId	string	L'identifiant du disque source. Ce champ est conservé même si le disque source a été libéré.	d-j6c3ogynmvpi6wy7****
SourceDiskType	string	Le type du disque source. Valeurs valides :	system
Available	boolean	Indique si l'instantané peut être utilisé pour créer des disques, restaurer des disques ou partager des instantanés. Valeurs valides :	false
Progress	string	La progression de la création de l'instantané, en pourcentage.	100%
InstantAccess	boolean	Indique si l'accès instantané à l'instantané est activé. Valeurs valides :	true
InstantAccessRetentionDays	integer	La période de rétention de la fonctionnalité d'accès instantané à l'instantané. Une fois la période de rétention expirée, l'instantané est automatiquement libéré.	3
Tags	object
Tag	array<object>	Les paires clé-valeur des balises de chaque instantané du groupe d'instantanés cohérents. Par défaut, les informations source de l'instantané sont incluses.
	object
Key	string	La clé de balise de chaque instantané du groupe d'instantanés cohérents. Les valeurs par défaut de Key et Value contiennent les informations source de l'instantané.	acs:ecs:createFrom
Value	string	La valeur de balise de chaque instantané du groupe d'instantanés cohérents. Les valeurs par défaut de Key et Value contiennent les informations source de l'instantané.	i-bp11qm0o3dk4iuc****

Exemples

JSON format

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "RequestId": "3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A",
  "SnapshotGroups": {
    "SnapshotGroup": [
      {
        "SnapshotGroupId": "ssg-j6ciyh3k52qp7ovm****",
        "InstanceId": "i-j6ca469urv8ei629****",
        "Status": "accomplished",
        "ProgressStatus": "null",
        "Name": "testName",
        "Description": "Ceci est une 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****"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.