DescribeSnapshots - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta la lista de instantáneas de un disco, incluido el estado de la instantánea, el tiempo restante para una instantánea en creación y los días de retención de instantáneas automáticas.

Descripción de la operación

InstanceId, DiskId y SnapshotIds no son parámetros de solicitud obligatorios, pero puede utilizarlos para crear lógica de filtrado. Estos parámetros se evalúan mediante una operación lógica AND.

Cuando invoque una operación de API mediante la CLI de Cloud Assistant, especifique los valores de los parámetros de solicitud en los formatos requeridos según sus tipos de datos. Para obtener más información, consulte Formato de parámetros de CLI.

Ejemplos de solicitudes:

Consulta de la lista de instantáneas de todos los discos conectados a una instancia de ECS en la región China (Hangzhou)

RegionId:  cn-hangzhou,   // Establezca la región en China (Hangzhou).
InstanceId:  i-bp1fh7by6d9mw7zr****   // Establezca el ID de la instancia a consultar.

Consulta de la información de instantáneas de un disco específico en la región China (Hangzhou)

RegionId:  cn-hangzhou,   // Establezca la región en China (Hangzhou).
DiskId:   d-bp10e7ej8z743dmu****   // Establezca el ID del disco a consultar.

Consulta de la información de dos instantáneas en la región China (Hangzhou) por ID de instantánea

RegionId:  cn-hangzhou,   // Establezca la región en China (Hangzhou).
SnapshotIds:   ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"]   // Establezca la matriz de ID de instantáneas a consultar.

Consulta de la información de instantáneas creadas después de un momento específico en la región China (Hangzhou)

RegionId:  cn-hangzhou,   // Establezca la región en China (Hangzhou).
Filter.1.Key:   CreationStartTime,   // Establezca la clave de filtro para la hora de inicio de creación.
Filter.1.Value:   2024-11-27T00:00Z.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:DescribeSnapshots

get

Snapshot

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

Snapshot

acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	No	El ID de la instancia. Especifique este parámetro para consultar la información de instantáneas de los discos conectados a la instancia.	i-bp67acfmxazb4p****
DiskId	string	No	El ID del disco.	d-bp67acfmxazb4p****
SnapshotLinkId	string	No	El ID de la cadena de instantáneas.	sl-bp1grgphbcc9brb5****
RegionId	string	Sí	El ID de la región del disco. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
SnapshotIds	string	No	Los ID de las instantáneas. El valor es una matriz JSON que consta de hasta 100 ID de instantáneas. Separe los ID con comas (,).	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]
PageNumber	integer	No	Nota Este parámetro está a punto de quedar obsoleto. Utilice NextToken y MaxResults para la paginación en su lugar.	1
PageSize	integer	No	Nota Este parámetro está a punto de quedar obsoleto. Utilice NextToken y MaxResults para la paginación en su lugar.	10
NextToken	string	No	El token de paginación. Se obtiene de la respuesta de la solicitud anterior.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	El número máximo de entradas por página para la paginación. Valor máximo: 100. Valor predeterminado: 10.	10
SnapshotName	string	No	El nombre de la instantánea.	testSnapshotName
Status	string	No	El estado de la instantánea. Valores válidos: progressing: La instantánea se está creando. accomplished: La instantánea se ha creado. failed: No se pudo crear la instantánea. all (predeterminado): Todos los estados de instantánea.	all
SnapshotType	string	No	El tipo de creación automática. Valores válidos: auto: instantánea automática. user: instantánea manual. all (predeterminado): Todos los tipos de creación automática.	all
Filter.1.Key	string	No	La clave de filtro utilizada para consultar recursos. Establezca el valor en `CreationStartTime`. Cuando especifica tanto `Filter.1.Key` como `Filter.1.Value`, puede consultar los recursos creados después del momento especificado.	CreationStartTime
Filter.2.Key	string	No	La clave de filtro utilizada para consultar recursos. Establezca el valor en `CreationEndTime`. Cuando especifica tanto `Filter.2.Key` como `Filter.2.Value`, puede consultar los recursos creados antes del momento especificado.	CreationEndTime
Filter.1.Value	string	No	El valor de filtro utilizado para consultar recursos. Cuando especifica este parámetro, también debe especificar `Filter.1.Key`. Especifique la hora en formato `yyyy-MM-ddTHH:mmZ` en UTC.	2019-12-13T17:00Z
Filter.2.Value	string	No	El valor de filtro utilizado para consultar recursos. Cuando especifica este parámetro, también debe especificar `Filter.2.Key`. Especifique la hora en formato `yyyy-MM-ddTHH:mmZ` en UTC.	2019-12-13T22:00Z
Usage	string	No	Especifica si la instantánea se ha utilizado para crear imágenes o discos. Valores válidos: image: La instantánea se ha utilizado para crear imágenes personalizadas. disk: La instantánea se ha utilizado para crear discos. image_disk: La instantánea se ha utilizado para crear tanto discos de datos como imágenes personalizadas. none: La instantánea no se ha utilizado.	none
SourceDiskType	string	No	El tipo del disco de origen. Valores válidos: system: disco del sistema. data: disco de datos. Nota El valor no distingue entre mayúsculas y minúsculas.	system
Encrypted	boolean	No	Especifica si se deben filtrar las instantáneas cifradas. Valor predeterminado: false.	false
ResourceGroupId	string	No	El ID del grupo de recursos. Cuando utiliza este parámetro para filtrar recursos, el recuento de recursos no puede superar los 1000. Nota No se admite el filtrado por grupo de recursos predeterminado.	rg-bp67acfmxazb4p****
DryRun	boolean	No	Especifica si se debe realizar solo una ejecución de prueba (dry run), sin ejecutar la solicitud real. true: realiza solo una ejecución de prueba. El sistema comprueba si la solicitud tiene problemas potenciales, incluidos pares de AccessKey no válidos, usuarios de RAM no autorizados y valores de parámetros faltantes. Si la solicitud no pasa la ejecución de prueba, se devuelve un mensaje de error. Si la solicitud pasa la ejecución de prueba, se devuelve el código de error DryRunOperation. false (predeterminado): realiza una ejecución de prueba y envía la solicitud. Si la solicitud pasa la ejecución de prueba, se devuelve un código de estado HTTP 2xx y se ejecuta la operación.	false
KMSKeyId	string	No	El ID de la clave de Key Management Service (KMS) utilizada por el disco de datos.	0e478b7a-4262-4802-b8cb-00d3fb40****
Category	string	No	La categoría de la instantánea. Valores válidos: Standard: instantánea estándar. Flash: instantánea local. Este valor está a punto de quedar obsoleto. Las instantáneas locales han sido reemplazadas por la función de acceso instantáneo a instantáneas. La descripción de la métrica es la siguiente: Si utilizó instantáneas locales antes del 14 de diciembre de 2020, puede utilizar este parámetro. El parámetro está activo. Si no utilizó instantáneas locales antes del 14 de diciembre de 2020, no puede utilizar este parámetro. archive: instantánea de archivo.	Standard
Tag	array<object>	No	Las etiquetas.
	object	No
key	string	No	La clave de etiqueta del recurso. Nota Para una mejor compatibilidad, utilice Tag.N.Key en su lugar.	SnapshotTest
Key	string	No	La clave de etiqueta de la instantánea. Valores válidos de N: 1 a 20. Si utiliza una sola etiqueta para filtrar recursos, el recuento de recursos con la etiqueta especificada no puede superar los 1000. Si utiliza varias etiquetas para filtrar recursos, el recuento de recursos con todas las etiquetas especificadas adjuntas no puede superar los 1000. Si el recuento de recursos supera los 1000, llame a la operación ListTagResources.	TestKey
Value	string	No	El valor de etiqueta de la instantánea. Valores válidos de N: 1 a 20.	TestValue
value	string	No	El valor de etiqueta del recurso. Nota Para una mejor compatibilidad, utilice Tag.N.Value en su lugar.	SnapshotTest

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
NextToken	string	El token de paginación para la siguiente consulta.	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	Nota Este parámetro está a punto de quedar obsoleto. Utilice NextToken y MaxResults para la paginación en su lugar.	10
PageNumber	integer	Nota Este parámetro está a punto de quedar obsoleto. Utilice NextToken y MaxResults para la paginación en su lugar.	1
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	El número total de instantáneas. Nota Cuando utiliza los parámetros `MaxResults` y `NextToken` para la paginación, el valor del parámetro `TotalCount` devuelto no es válido.	1
Snapshots	object
Snapshot	array<object>	Los detalles de las instantáneas.
	array<object>
Status	string	El estado de la instantánea. Valores válidos: progressing: La instantánea se está creando. accomplished: La instantánea se ha creado. failed: No se pudo crear la instantánea.	accomplished
CreationTime	string	La hora en que se creó la instantánea. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2020-08-20T14:52:28Z
Progress	string	El progreso de creación de la instantánea, en porcentaje.	100%
InstantAccess	boolean	Indica si la función de acceso instantáneo a instantáneas está habilitada. Valores válidos: true: Habilitado. Los discos SSD empresariales y los discos ESSD Entry tienen esta función activa de forma predeterminada. false: Deshabilitado. La instantánea es una instantánea estándar sin la función de acceso instantáneo habilitada. Nota Este parámetro está obsoleto. Las instantáneas estándar para discos SSD empresariales se han actualizado a acceso instantáneo de forma predeterminada. No se requiere configuración adicional ni costo extra.	false
Available	boolean	Indica si la instantánea se puede utilizar para crear discos, revertir discos o compartir instantáneas. Valores válidos: true: disponible. false: no disponible.	false
RemainTime	integer	El tiempo restante necesario para crear la instantánea, en segundos.	38
SourceDiskSize	string	La capacidad del disco de origen. Unidad: GiB.	40
RetentionDays	integer	El número de días durante los cuales se conserva la instantánea automática.	30
SourceDiskType	string	El tipo del disco de origen. Valores válidos: system data	system
SourceStorageType	string	El tipo del disco de origen. Nota Este parámetro está próximo a quedar obsoleto. Para una mejor compatibilidad, utilice otros parámetros en su lugar.	disk
Usage	string	Indica si la instantánea se ha utilizado para crear imágenes o discos. Valores válidos: image: imagen personalizada. disk: disco. image_disk: imagen personalizada y disco de datos. none: no utilizada.	image
LastModifiedTime	string	La hora en que se modificó por última vez la instantánea. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.	2020-08-25T14:18:09Z
Encrypted	boolean	Indica si la instantánea está cifrada. Valores válidos: true: cifrada. false: no cifrada.	false
SnapshotType	string	El tipo de creación automática. Valores válidos: auto o timer: instantánea automática. user: instantánea manual. all: todos los tipos de creación automática.	all
SourceDiskId	string	El ID del disco de origen. Este campo se conserva incluso si el disco de origen se ha liberado.	d-bp67acfmxazb4ph****
SnapshotName	string	El nombre para mostrar de la instantánea. Este valor se devuelve si se especificó un nombre para mostrar al crear la instantánea.	testSnapshotName
InstantAccessRetentionDays	integer	El período de retención de la función de acceso instantáneo a instantáneas. Una vez que expira el período de retención, la función de acceso instantáneo a instantáneas se deshabilita automáticamente. El valor predeterminado es el mismo que el valor de `RetentionDays`. Nota Este parámetro está obsoleto. Las instantáneas estándar para discos SSD empresariales se han actualizado a acceso instantáneo de forma predeterminada. No se requiere configuración adicional ni costo extra.	30
Description	string	La descripción de la instantánea.	testDescription
SnapshotId	string	El ID de la instantánea.	s-bp67acfmxazb4p****
RegionId	string	El ID de región de la instantánea.	cn-hangzhou
ResourceGroupId	string	El ID del grupo de recursos.	rg-bp67acfmxazb4p****
Category	string	La categoría de la instantánea. Valores válidos: Standard: instantánea estándar. Flash: instantánea local. Este valor está próximo a quedar obsoleto. Las instantáneas locales han sido reemplazadas por la función de acceso instantáneo a instantáneas. archive: instantánea de archivo.	standard
KMSKeyId	string	El ID de la clave de Key Management Service (KMS) utilizada por el disco de datos.	0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSN	string	El número de serie de la instantánea.	64472-116742336-61976****
ProductCode	string	El código de producto heredado de la imagen de Alibaba Cloud Marketplace.	jxsc000****
SourceSnapshotId	string	El ID de la instantánea de origen.	s-bp67acfmxazb4p****
SourceRegionId	string	El ID de región de la instantánea de origen.	cn-hangzhou
FullSnapshotSizeInBytes	integer		65535
Tags	object
Tag	array<object>	Las etiquetas.
	object
TagValue	string	El valor de etiqueta de la instantánea.	TestValue
TagKey	string	La clave de etiqueta de la instantánea.	TestKey
SnapshotLinkId	string	El ID de la cadena de instantáneas asociada a la instantánea.	sl-bp1grgphbcc9brb5****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "PageSize": 10,
  "PageNumber": 1,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "CreationTime": "2020-08-20T14:52:28Z",
        "Progress": "100%",
        "InstantAccess": false,
        "Available": false,
        "RemainTime": 38,
        "SourceDiskSize": "40",
        "RetentionDays": 30,
        "SourceDiskType": "system",
        "SourceStorageType": "disk",
        "Usage": "image",
        "LastModifiedTime": "2020-08-25T14:18:09Z",
        "Encrypted": false,
        "SnapshotType": "all",
        "SourceDiskId": "d-bp67acfmxazb4ph****",
        "SnapshotName": "testSnapshotName",
        "InstantAccessRetentionDays": 30,
        "Description": "testDescription",
        "SnapshotId": "s-bp67acfmxazb4p****",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "Category": "standard",
        "KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
        "SnapshotSN": "64472-116742336-61976****",
        "ProductCode": "jxsc000****",
        "SourceSnapshotId": "s-bp67acfmxazb4p****",
        "SourceRegionId": "cn-hangzhou",
        "FullSnapshotSizeInBytes": 65535,
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "SnapshotLinkId": "sl-bp1grgphbcc9brb5****"
      }
    ]
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	The specified Tag.N.Key and Tag.N.Value parameters do not correspond to each other.
400	InvalidTagCount	The specified tags are beyond the permitted range.	The number of specified tags exceeds the upper limit.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	The specified Category parameter is invalid.
403	InvalidCategory.SnapshotLinkMismatch	The specified category does not match the actual category of the snapshot link.	The specified category does not match the snapshot chain.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.	The specified filter key does not exist.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.	The specified filter value is invalid.
404	InvalidUsage	The specifed Usage is not valid.	The specified Usage parameter is invalid.
404	InvalidSourceDiskType	The specifed SourceDiskType is not valid.
404	InvalidStatus.NotFound	The specified Status is not found.
404	InvalidSnapshotType.NotFound	The specfied SnapshotType is not found.
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.	The specified snapshot chain does not exist.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.