DescribeSnapshots - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta os snapshots de um disco em nuvem, incluindo o status do snapshot, o tempo restante para a criação do snapshot e o período de retenção de snapshots automáticos.

Descrição da operação

InstanceId, DiskId e SnapshotIds não são parâmetros de solicitação obrigatórios, mas você pode usá-los para criar uma lógica de filtro. A relação lógica entre esses parâmetros é AND.

Ao invocar operações de API usando o Cloud Assistant CLI, os valores dos parâmetros de solicitação de diferentes tipos de dados devem seguir requisitos de formato específicos. Para obter mais detalhes, consulte Descrição do formato de parâmetro da CLI.

Exemplos de solicitação:

Consultar a lista de snapshots de todos os discos em nuvem de uma instância ECS na região da China (Hangzhou)

RegionId:  cn-hangzhou,   // Configurações para a região da China (Hangzhou).
InstanceId:  i-bp1fh7by6d9mw7zr****   // Configurações para o ID da instância a ser consultada.

Consultar as informações de snapshot de um disco em nuvem específico na região da China (Hangzhou)

RegionId:  cn-hangzhou,   // Defina a região como China (Hangzhou).
DiskId:   d-bp10e7ej8z743dmu****   // Defina o ID do disco em nuvem a ser consultado.

Consultar as informações de dois snapshots por ID de snapshot na região da China (Hangzhou)

RegionId:  cn-hangzhou,   // Defina a região como China (Hangzhou).
SnapshotIds:   ["d-bp10e7ej8z743dmu****", "s-bp19vd1lorzgzt2s****"]   // Defina a matriz de IDs de snapshot a serem consultados.

Consultar as informações de snapshots criados após um ponto específico no tempo na região da China (Hangzhou)

RegionId:  cn-hangzhou,   // Defina a região como China (Hangzhou).
Filter.1.Key:   CreationStartTime,   // Defina a matriz de IDs de snapshot a serem consultados.
Filter.1.Value:   2024-11-27T00:00Z.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Não	O ID da instância. Este parâmetro especifica a instância cujos snapshots de disco em nuvem você deseja consultar.	i-bp67acfmxazb4p****
DiskId	string	Não	O ID do disco em nuvem.	d-bp67acfmxazb4p****
SnapshotLinkId	string	Não	O ID da cadeia de snapshots.	sl-bp1grgphbcc9brb5****
RegionId	string	Sim	O ID da região do disco em nuvem. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou
SnapshotIds	string	Não	Os IDs dos snapshots. O valor pode ser uma matriz JSON que consiste em até 100 IDs de snapshot. Separe vários IDs com vírgulas (,).	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", … "s-bp67acfmxazb6p**"]
PageNumber	integer	Não	Nota Este parâmetro será desativado em breve. Recomendamos que você use os parâmetros NextToken e MaxResults para realizar a paginação em operações de consulta paginada.	1
PageSize	integer	Não	Nota Este parâmetro será desativado em breve. Recomendamos que você use os parâmetros NextToken e MaxResults para realizar a paginação em operações de consulta paginada.	10
NextToken	string	Não	O token de paginação. Obtenha o token a partir da resposta da solicitação anterior.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	Não	O número de entradas por página durante a paginação para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
SnapshotName	string	Não	O nome do snapshot.	testSnapshotName
Status	string	Não	O status do snapshot. Valores válidos: progressing: O snapshot está sendo criado. accomplished: O snapshot foi criado. failed: Falha ao criar o snapshot. all: Todos os status. Este é o valor padrão.	all
SnapshotType	string	Não	O tipo de criação do snapshot. Valores válidos: auto: criação automática. user: criação manual. all: todos os tipos de criação de snapshot. Este é o valor padrão.	all
Filter.1.Key	string	Não	A chave de filtro usada para consultar recursos. O valor deve ser CreationStartTime. Se você especificar Filter.1.Key e Filter.1.Value, poderá consultar os recursos criados após o ponto no tempo especificado.	CreationStartTime
Filter.2.Key	string	Não	A chave de filtro usada para consultar recursos. O valor deve ser CreationEndTime. Se você especificar Filter.2.Key e Filter.2.Value, poderá consultar os recursos criados antes do ponto no tempo especificado.	CreationEndTime
Filter.1.Value	string	Não	O valor de filtro usado para consultar recursos. Se você especificar este parâmetro, também deverá especificar o parâmetro Filter.1.Key. O valor deve estar no formato yyyy-MM-ddTHH:mmZ e em UTC+0.	2019-12-13T17:00Z
Filter.2.Value	string	Não	O valor de filtro usado para consultar recursos. Se você especificar este parâmetro, também deverá especificar o parâmetro Filter.2.Key. O valor deve estar no formato yyyy-MM-ddTHH:mmZ e em UTC+0.	2019-12-13T22:00Z
Usage	string	Não	O uso do snapshot. Valores válidos: image: O snapshot é usado para criar uma imagem personalizada. disk: O snapshot é usado para criar um disco em nuvem. image_disk: O snapshot é usado para criar um disco de dados e uma imagem personalizada. none: O snapshot não é usado.	none
SourceDiskType	string	Não	O tipo do disco em nuvem de origem. Valores válidos: system: O disco em nuvem de origem é um disco do sistema. data: O disco em nuvem de origem é um disco de dados. Nota O valor não diferencia maiúsculas de minúsculas.	system
Encrypted	boolean	Não	Especifica se deve filtrar snapshots criptografados. Valor padrão: false.	false
ResourceGroupId	string	Não	O ID do grupo de recursos. Ao usar este parâmetro para filtrar recursos, a contagem de recursos não pode exceder 1.000. Nota A filtragem pelo grupo de recursos padrão não é suportada.	rg-bp67acfmxazb4p****
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run na solicitação. Valores válidos: true: envia uma solicitação de verificação sem consultar o status do recurso. O sistema verifica se o seu par de AccessKey é válido, se o usuário do Resource Access Management (RAM) tem a autorização necessária e se os parâmetros necessários foram especificados. Se a verificação falhar, o erro correspondente será retornado. Se a verificação for bem-sucedida, o código de erro DryRunOperation será retornado. false (padrão): envia uma solicitação Normal. Se a verificação for bem-sucedida, um código de status HTTP 2xx será retornado e o status do recurso será consultado.	false
KMSKeyId	string	Não	O ID da chave KMS usada para o disco de dados.	0e478b7a-4262-4802-b8cb-00d3fb40****
Category	string	Não	O tipo de snapshot. Valores válidos: Standard: snapshot padrão. Flash: snapshot local. Este valor de parâmetro será descontinuado. Os snapshots locais são substituídos pelo recurso de ativação instantânea de snapshot. A descrição da métrica deste parâmetro é a seguinte: Se você usou snapshots locais antes de 14 de dezembro de 2020, pode usar este parâmetro para uso Normal. Se você não usou snapshots locais antes de 14 de dezembro de 2020, não pode usar este parâmetro. archive: snapshot de arquivo.	Standard
Tag	array<object>	Não	A lista de tags.
	object	Não
key	string	Não	A chave da tag do recurso. Nota Para melhorar a compatibilidade, use o parâmetro Tag.N.Key.	SnapshotTest
Key	string	Não	A chave da tag do snapshot. Valores válidos de N: 1 a 20. Se você usar uma única tag para filtrar recursos, a contagem de recursos consultados não pode exceder 1.000. Se você usar várias tags para filtrar recursos, a contagem de recursos consultados que estão anexados a todas as tags especificadas não pode exceder 1.000. Se a contagem de recursos exceder 1.000, use a operação ListTagResources para consultar os recursos.	TestKey
Value	string	Não	O valor da tag do snapshot. Valores válidos de N: 1 a 20.	TestValue
value	string	Não	O valor da tag do recurso. Nota Para melhorar a compatibilidade, use o parâmetro Tag.N.Value.	SnapshotTest

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação para a próxima consulta.	caeba0bbb2be03f84eb48b699f0a4883
PageSize	integer	Nota Este parâmetro será descontinuado em breve. Use NextToken e MaxResults para consultas paginadas.	10
PageNumber	integer	Nota Este parâmetro será descontinuado em breve. Use NextToken e MaxResults para consultas paginadas.	1
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	O número total de snapshots. Nota Quando você usa os parâmetros MaxResults e NextToken para consultas paginadas, o valor retornado de TotalCount é inválido.	1
Snapshots	object
Snapshot	array<object>	Os detalhes do snapshot.
	array<object>
Status	string	O status do snapshot. Valores válidos: progressing: O snapshot está sendo criado. accomplished: O snapshot foi criado. failed: A criação do snapshot falhou.	accomplished
CreationTime	string	A hora de criação. A hora é exibida em UTC e segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ.	2020-08-20T14:52:28Z
Progress	string	O progresso de criação do snapshot, em porcentagem.	100%
InstantAccess	boolean	Indica se o recurso de acesso instantâneo ao snapshot está ativado. Valores válidos: true: ativado. Este recurso é ativado por padrão para SSDs corporativos e discos ESSD Entry. false: desativado. O snapshot é um snapshot padrão para o qual o recurso de acesso instantâneo não está ativado. Nota [Descontinuado] Este parâmetro foi descontinuado. Os snapshots padrão de SSDs corporativos são atualizados para acesso instantâneo por padrão. Nenhuma configuração ou taxa adicional é necessária.	false
Available	boolean	Indica se o snapshot pode ser usado para criar discos, reverter discos ou compartilhar snapshots. Valores válidos: true: sim false: não	false
RemainTime	integer	O tempo restante necessário para criar o snapshot. Unidade: segundos.	38
SourceDiskSize	string	A capacidade do disco de origem. Unidade: GiB.	40
RetentionDays	integer	O período de retenção do snapshot automático, em dias.	30
SourceDiskType	string	O tipo do disco de origem. Valores válidos: system data	system
SourceStorageType	string	O tipo de armazenamento do disco de origem. Nota Este parâmetro será descontinuado em breve. Para melhorar a compatibilidade, use outros parâmetros.	disk
Usage	string	O uso do snapshot. Valores válidos: image: imagem personalizada disk: disco image_disk: imagem personalizada e disco de dados none: não utilizado	image
LastModifiedTime	string	A hora da última modificação do snapshot. A hora é exibida em UTC e segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ.	2020-08-25T14:18:09Z
Encrypted	boolean	Indica se o snapshot está criptografado. Valores válidos: true: sim false: não	false
SnapshotType	string	O tipo de criação automática. Valores válidos: auto or timer: snapshot automático user: snapshot manual all: todos os tipos de criação automática	all
SourceDiskId	string	O ID do disco de origem. Se o disco de origem do snapshot tiver sido liberado, este campo ainda será mantido.	d-bp67acfmxazb4ph****
SnapshotName	string	O nome de exibição do snapshot. Este parâmetro é retornado apenas se um nome de exibição tiver sido especificado quando o snapshot foi criado.	testSnapshotName
InstantAccessRetentionDays	integer	O período de retenção do recurso de acesso instantâneo ao snapshot. Após o término do período de retenção, o recurso de acesso instantâneo ao snapshot é desativado automaticamente. Valor padrão: o valor do parâmetro RetentionDays. Nota [Descontinuado] Este parâmetro foi descontinuado. Os snapshots padrão de SSDs corporativos são atualizados para acesso instantâneo por padrão. Nenhuma configuração ou taxa adicional é necessária.	30
Description	string	A descrição.	testDescription
SnapshotId	string	O ID do snapshot.	s-bp67acfmxazb4p****
RegionId	string	O ID da região do snapshot.	cn-hangzhou
ResourceGroupId	string	O ID do grupo de recursos.	rg-bp67acfmxazb4p****
Category	string	O tipo de snapshot. Valores válidos: Standard: snapshot padrão Flash: snapshot local. Este valor será descontinuado em breve. Os snapshots locais são substituídos pelo recurso de acesso instantâneo ao snapshot. archive: snapshot de arquivamento	standard
KMSKeyId	string	O ID da chave KMS usada para o disco de dados.	0e478b7a-4262-4802-b8cb-00d3fb40****
SnapshotSN	string	O número de série do snapshot.	64472-116742336-61976****
ProductCode	string	O código do produto herdado da imagem do Alibaba Cloud Marketplace.	jxsc000****
SourceSnapshotId	string	O snapshot de origem.	s-bp67acfmxazb4p****
SourceRegionId	string	A região do snapshot de origem.	cn-hangzhou
FullSnapshotSizeInBytes	integer	O tamanho total do snapshot. Unidade: bytes.	65535
Tags	object
Tag	array<object>	As tags.
	object
TagValue	string	O valor da tag do snapshot.	TestValue
TagKey	string	A chave da tag do snapshot.	TestKey
SnapshotLinkId	string	O ID da cadeia de snapshots associada ao snapshot.	sl-bp1grgphbcc9brb5****

Exemplos

Resposta de sucesso

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidTag.Mismatch	The specified Tag.n.Key and Tag.n.Value are not match.	O Tag.N.Key e o Tag.N.Value especificados não correspondem.
400	InvalidTagCount	The specified tags are beyond the permitted range.	O marcador especificado está fora do intervalo.
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.	O tipo de snapshot especificado é inválido. Verifique se o valor do parâmetro Category está correto.
403	InvalidCategory.SnapshotLinkMismatch	The specified category does not match the actual category of the snapshot link.	A categoria especificada não corresponde à cadeia de snapshots.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.	O parâmetro de hora de início ou hora de término especificado é inválido.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.	O formato de hora especificado é inválido.
404	InvalidUsage	The specifed Usage is not valid.	O tipo de recurso referenciado especificado (image, disk, image_disk ou none) é inválido.
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.	A cadeia de snapshots especificada não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.