DescribeSnapshotGroups - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Spécifiez plusieurs paramètres de requête, tels que InstanceId, SnapshotGroupId.N et Status.N, pour filtrer les résultats. Les paramètres spécifiés sont liés par une relation logique ET. Seuls les paramètres indiqués sont inclus dans les conditions de filtrage.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeSnapshotGroups	L'opération à effectuer. Définissez la valeur sur DescribeSnapshotGroups.
RegionId	String	Yes	cn-hangzhou	L'ID de région des groupes de snapshots cohérents. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
InstanceId	String	No	i-j6ca469urv8ei629****	L'ID de l'instance.
Name	String	No	testName	Le nom du groupe de snapshots cohérents.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats. Ne spécifiez pas ce paramètre lors de la première requête. Spécifiez le jeton obtenu lors de la requête précédente comme valeur de NextToken.
MaxResults	Integer	No	10	Le nombre d'entrées par page. Valeurs valides : 1 à 100. Valeur par défaut : 10.
SnapshotGroupId.N	String	No	ssg-j6ciyh3k52qp7ovm****	L'ID du groupe de snapshots cohérents N. Valeurs valides de N : 1 à 10.
Status.N	String	No	accomplished	L'état du groupe de snapshots cohérents N. Valeurs valides de N : 1 à 3. Valeurs valides : progressing : Le groupe de snapshots cohérents est en cours de création. accomplished : Le groupe de snapshots cohérents est créé. failed : La création du groupe de snapshots cohérents a échoué.
AdditionalAttributes.N	String	No	null	Remarque Ce paramètre n'est pas disponible publiquement.
Tag.N.Key	String	No	TestKey	La clé du tag N du groupe de snapshots cohérents. Valeurs valides de N : 1 à 20.
Tag.N.Value	String	No	TestValue	La valeur du tag N du groupe de snapshots cohérents. Valeurs valides de N : 1 à 20.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	L'ID du groupe de ressources du groupe de snapshots cohérents.

Paramètres de réponse

Parameter	Type	Example	Description
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Le jeton de pagination. Utilisez-le dans la requête suivante pour récupérer une nouvelle page de résultats. Remarque Si ce paramètre est vide, aucune autre donnée n'est renvoyée.
RequestId	String	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A	L'ID de la requête.
SnapshotGroups	Array of SnapshotGroup		Détails des groupes de snapshots cohérents.
SnapshotGroup
Status	String	accomplished	L'état du groupe de snapshots cohérents N. Valeurs valides : progressing : Le groupe de snapshots cohérents est en cours de création. accomplished : Le groupe de snapshots cohérents est créé. failed : La création du groupe de snapshots cohérents a échoué.
CreationTime	String	2021-03-23T10:58:48Z	L'heure de création du groupe de snapshots cohérents.
Description	String	This is description.	La description du groupe de snapshots cohérents.
ProgressStatus	String	null	Remarque Ce paramètre n'est pas disponible publiquement.
SnapshotGroupId	String	ssg-j6ciyh3k52qp7ovm****	L'ID du groupe de snapshots cohérents.
InstanceId	String	i-j6ca469urv8ei629****	L'ID d'instance du groupe de snapshots cohérents. Ce paramètre possède une valeur uniquement lorsque tous les snapshots de disque du groupe de snapshots cohérents appartiennent à la même instance. Si les snapshots de disque du groupe de snapshots cohérents appartiennent à différentes instances, utilisez les paramètres commençant par `Snapshots.Snapshot.Tags.` dans la réponse pour consulter l'ID de l'instance à laquelle appartient chaque snapshot du groupe de snapshots cohérents.
Name	String	testName	Le nom du groupe de snapshots cohérents.
ResourceGroupId	String	rg-bp67acfmxazb4p****	L'ID du groupe de ressources auquel appartient le groupe de snapshots cohérents.
Tags	Array of Tag		Les tags du groupe de snapshots cohérents.
Tag
Key	String	TestKey	La clé de tag du groupe de snapshots cohérents.
Value	String	TestValue	La valeur de tag du groupe de snapshots cohérents.
Snapshots	Array of Snapshot		Détails des snapshots dans le groupe de snapshots cohérents.
Snapshot
SourceDiskId	String	d-j6c3ogynmvpi6wy7****	L'ID du disque source. Ce paramètre est conservé même après la libération du disque source du snapshot.
Progress	String	100 %	La progression de la tâche de création du snapshot. Unité : pourcentage (%).
Available	Boolean	false	Indique si le snapshot peut être utilisé pour créer ou restaurer des disques. Valeurs valides : true false
InstantAccessRetentionDays	Integer	3	La période de rétention de la fonctionnalité d'accès instantané. Une fois la période de rétention écoulée, le snapshot est automatiquement libéré.
SnapshotId	String	s-j6cbzmrlbf09w72q****	L'ID du snapshot.
InstantAccess	Boolean	true	Indique si la fonctionnalité d'accès instantané est activée. Valeurs valides : true : La fonctionnalité d'accès instantané est activée. Cette fonctionnalité ne peut être activée que pour les disques ESSD (Enhanced SSD). false : La fonctionnalité d'accès instantané est désactivée. Le snapshot est un snapshot normal pour lequel la fonctionnalité d'accès instantané est désactivée.
SourceDiskType	String	system	Le type du disque source. Valeurs valides : system : disque système data : disque de données
Tags	Array of Tag		Les tags des snapshots dans le groupe de snapshots cohérents. La valeur par défaut contient les détails de l'instance à laquelle appartient le groupe de snapshots cohérents.
Tag
Key	String	acs:ecs:createFrom	La clé de tag de chaque snapshot dans le groupe de snapshots cohérents. Les valeurs par défaut de Key et Value contiennent les détails de l'instance à laquelle appartient le groupe de snapshots cohérents.
Value	String	i-bp11qm0o3dk4iuc****	La valeur de tag de chaque snapshot dans le groupe de snapshots cohérents. Les valeurs par défaut de Key et Value contiennent les détails de l'instance à laquelle appartient le groupe de snapshots cohérents.

Exemples

Exemples de requêtes

https://ecs.aliyuncs.com/?Action=DescribeSnapshotGroups
&RegionId=cn-hangzhou
&SnapshotGroupId.1=ssg-j6ciyh3k52qp7ovm****
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<DescribeSnapshotGroupsResponse>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <RequestId>3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A</RequestId>
    <SnapshotGroups>
        <SnapshotGroup>
            <Status>accomplished</Status>
            <Description>This is description.</Description>
            <InstanceId/>
            <CreationTime>2021-03-23T10:58:48Z</CreationTime>
            <SnapshotGroupId>ssg-j6ciyh3k52qp7ovm****</SnapshotGroupId>
            <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
            <Name>testName</Name>
            <Tags>
                <Tag>
                    <Value>TestValue</Value>
                    <Key>TestKey</Key>
                </Tag>
            </Tags>
            <Snapshots>
                <Snapshot>
                    <SnapshotId>s-j6cbzmrlbf09w72q****</SnapshotId>
                    <Progress>100%</Progress>
                    <Available>false</Available>
                    <InstantAccessRetentionDays>3</InstantAccessRetentionDays>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-j6c3ogynmvpi6wy7****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp11qm0o3dk4iuc****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
                <Snapshot>
                    <SnapshotId>s-bp1fgrjucs8wr31****</SnapshotId>
                    <Progress>100%</Progress>
                    <SourceDiskType>system</SourceDiskType>
                    <SourceDiskId>d-bp1bcsu5leotddp****</SourceDiskId>
                    <Tags>
                        <Tag>
                            <Value>i-bp1emqgxsg88zdl****</Value>
                            <Key>acs:ecs:createFrom</Key>
                        </Tag>
                    </Tags>
                </Snapshot>
            </Snapshots>
        </SnapshotGroup>
    </SnapshotGroups>
</DescribeSnapshotGroupsResponse>

JSON format

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

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

Codes d'erreur

HTTP status code	Error code	Error message	Description
403	InvalidStatus.ValueNotSupported	%s	Cette opération ne peut pas être effectuée sur la ressource dans son état actuel.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.