DescribeSnapshotGroups - - Centro de documentación de Alibaba Cloud

Consulta los detalles de los grupos consistentes de instantáneas.

Notas de uso

Puede especificar varios parámetros de solicitud, como InstanceId, SnapshotGroupId.N y Status.N, para filtrar la consulta. Los parámetros especificados tienen una relación lógica AND. Solo los parámetros indicados se incluyen en las condiciones de filtro.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeSnapshotGroups	La operación que desea ejecutar. Establezca el valor en DescribeSnapshotGroups.
RegionId	String	Sí	cn-hangzhou	El ID de región de los grupos consistentes de instantáneas. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
InstanceId	String	No	i-j6ca469urv8ei629****	El ID de la instancia.
Name	String	No	testName	El nombre del grupo consistente de instantáneas.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	El token de paginación que se usa en la siguiente solicitud para recuperar una nueva página de resultados. No es necesario especificar este parámetro en la primera solicitud. Debe especificar el token obtenido de la consulta anterior como valor de NextToken.
MaxResults	Integer	No	10	El número de entradas por página. Valores válidos: 1 a 100. Valor predeterminado: 10.
SnapshotGroupId.N	String	No	ssg-j6ciyh3k52qp7ovm****	El ID del grupo consistente de instantáneas N. Valores válidos de N: 1 a 10.
Status.N	String	No	accomplished	El estado del grupo consistente de instantáneas N. Valores válidos de N: 1 a 3. Valores válidos: progressing: El grupo consistente de instantáneas se está creando. accomplished: El grupo consistente de instantáneas se creó correctamente. failed: La creación del grupo consistente de instantáneas falló.
AdditionalAttributes.N	String	No	null	Nota Este parámetro no está disponible públicamente.
Tag.N.Key	String	No	TestKey	La clave de la etiqueta N del grupo consistente de instantáneas. Valores válidos de N: 1 a 20.
Tag.N.Value	String	No	TestValue	El valor de la etiqueta N del grupo consistente de instantáneas. Valores válidos de N: 1 a 20.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	El ID del resource group del grupo consistente de instantáneas.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	El token de paginación. Se puede usar en la siguiente solicitud para recuperar una nueva página de resultados. Nota Si este parámetro está vacío, no se devuelven más datos.
RequestId	String	3F9A4CC4-362F-469A-B9EF-B3204EF8AA3A	El ID de la solicitud.
SnapshotGroups	Array of SnapshotGroup		Detalles de los grupos consistentes de instantáneas.
SnapshotGroup
Status	String	accomplished	El estado del grupo consistente de instantáneas N. Valores válidos: progressing: El grupo consistente de instantáneas se está creando. accomplished: El grupo consistente de instantáneas se creó correctamente. failed: La creación del grupo consistente de instantáneas falló.
CreationTime	String	2021-03-23T10:58:48Z	La hora en que se creó el grupo consistente de instantáneas.
Description	String	This is description.	La descripción del grupo consistente de instantáneas.
ProgressStatus	String	null	Nota Este parámetro no está disponible públicamente.
SnapshotGroupId	String	ssg-j6ciyh3k52qp7ovm****	El ID del grupo consistente de instantáneas.
InstanceId	String	i-j6ca469urv8ei629****	El ID de instancia del grupo consistente de instantáneas. Este parámetro solo tiene valor cuando todas las instantáneas de disco del grupo pertenecen a la misma instancia. Si las instantáneas de disco del grupo pertenecen a distintas instancias, use los parámetros que comienzan con `Snapshots.Snapshot.Tags.` en la respuesta para consultar el ID de la instancia a la que pertenece cada instantánea del grupo.
Name	String	testName	El nombre del grupo consistente de instantáneas.
ResourceGroupId	String	rg-bp67acfmxazb4p****	El ID del resource group al que pertenece el grupo consistente de instantáneas.
Tags	Array of Tag		Las etiquetas del grupo consistente de instantáneas.
Tag
Key	String	TestKey	La clave de etiqueta del grupo consistente de instantáneas.
Value	String	TestValue	El valor de etiqueta del grupo consistente de instantáneas.
Snapshots	Array of Snapshot		Detalles de las instantáneas en el grupo consistente de instantáneas.
Snapshot
SourceDiskId	String	d-j6c3ogynmvpi6wy7****	El ID del disco de origen. Este parámetro se conserva incluso después de liberar el disco de origen de la instantánea.
Progress	String	100%	El progreso de la tarea de creación de la instantánea. Unidad: porcentaje (%).
Available	Boolean	false	Indica si la instantánea se puede usar para crear o restaurar discos. Valores válidos: true false
InstantAccessRetentionDays	Integer	3	El periodo de retención de la función de acceso instantáneo. Una vez finalizado este periodo, la instantánea se libera automáticamente.
SnapshotId	String	s-j6cbzmrlbf09w72q****	El ID de la instantánea.
InstantAccess	Boolean	true	Indica si la función de acceso instantáneo está habilitada. Valores válidos: true: La función de acceso instantáneo está habilitada. Esta función solo se puede habilitar para SSD mejorados (ESSD). false: La función de acceso instantáneo está deshabilitada. La instantánea es una instantánea normal con la función de acceso instantáneo deshabilitada.
SourceDiskType	String	system	El tipo de disco de origen. Valores válidos: system: disco del sistema data: disco de datos
Tags	Array of Tag		Las etiquetas de las instantáneas en el grupo consistente de instantáneas. El valor predeterminado contiene los detalles de la instancia a la que pertenece el grupo consistente de instantáneas.
Tag
Key	String	acs:ecs:createFrom	La clave de etiqueta de cada instantánea en el grupo consistente de instantáneas. Los valores predeterminados de Key y Value contienen los detalles de la instancia a la que pertenece el grupo consistente de instantáneas.
Value	String	i-bp11qm0o3dk4iuc****	El valor de etiqueta de cada instantánea en el grupo consistente de instantáneas. Los valores predeterminados de Key y Value contienen los detalles de la instancia a la que pertenece el grupo consistente de instantáneas.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

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>

Formato JSON

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"
            } ]
          }
        } ]
      }
    } ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	InvalidStatus.ValueNotSupported	%s	Esta operación no se puede realizar en el recurso con el estado actual.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.