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

Observações de uso

É possível especificar vários parâmetros de solicitação, como InstanceId, DiskId e SnapshotIds, para filtrar a consulta. Os parâmetros especificados têm relação lógica AND. Apenas os parâmetros definidos são incluídos nas condições de filtro.

Ao usar a CLI do Alibaba Cloud para chamar uma operação de API, especifique os valores dos parâmetros de solicitação de diferentes tipos de dados nos formatos obrigatórios. Para mais informações, consulte Visão geral do formato de parâmetros.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSnapshots	A operação a ser executada. Defina o valor como DescribeSnapshots.
InstanceId	String	Não	i-bp67acfmxazb4p****	O ID da instância.
DiskId	String	Não	d-bp67acfmxazb4p****	O ID do disco.
SnapshotLinkId	String	Não	sl-bp1grgphbcc9brb5****	O ID da cadeia de snapshots.
RegionId	String	Sim	cn-hangzhou	O ID da região do disco. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
SnapshotIds	String	Não	["s-bp67acfmxazb4p**", "s-bp67acfmxazb5p", ... "s-bp67acfmxazb6p**"]	Os IDs dos snapshots. O valor pode ser um array JSON composto por até 100 IDs de snapshot. Separe os IDs com vírgulas (,).
PageNumber	Integer	Não	1	O número da página. A paginação começa na página 1. Valor padrão: 1.
PageSize	Integer	Não	10	O número de entradas por página. Valor máximo: 100. Valor padrão: 10.
NextToken	String	Não	caeba0bbb2be03f84eb48b699f0a4883	O token de paginação usado nesta solicitação para recuperar uma nova página de resultados. Não é necessário especificar este parâmetro na primeira solicitação. Especifique o token obtido na consulta anterior como o valor de NextToken.
MaxResults	Integer	Não	10	O número máximo de entradas por página. Valor máximo: 100. Valor padrão: 10.
SnapshotName	String	Não	testSnapshotName	O nome do snapshot.
Status	String	Não	all	O estado do snapshot. Valores válidos: progressing: o snapshot está sendo criado. accomplished: o snapshot foi criado. failed: falha na criação do snapshot. all (padrão): indica todos os estados de snapshot.
SnapshotType	String	Não	all	O tipo do snapshot. Valores válidos: auto: snapshot automático. user: snapshot manual. all (padrão): todos os tipos de snapshot.
Filter.1.Key	String	Não	CreationStartTime	A chave do filtro 1 usada para consultar recursos. Defina o valor como `CreationStartTime`. Defina um horário especificando tanto `Filter.1.Key` quanto `Filter.1.Value` para consultar recursos criados após esse momento.
Filter.2.Key	String	Não	CreationEndTime	A chave do filtro 2 usada para consultar recursos. Defina o valor como `CreationEndTime`. Defina um horário especificando tanto `Filter.2.Key` quanto `Filter.2.Value` para consultar recursos criados antes desse momento.
Filter.1.Value	String	Não	2019-12-13T17:00Z	O valor do filtro 1 usado para consultar recursos. Defina o valor como um horário. Se você especificar este parâmetro, também deverá especificar `Filter.1.Key`. Especifique o horário no formato `yyyy-MM-ddTHH:mmZ`. O horário deve estar em UTC.
Filter.2.Value	String	Não	2019-12-13T22:00Z	O valor do filtro 2 usado para consultar recursos. Defina o valor como um horário. Se você especificar este parâmetro, também deverá especificar `Filter.2.Key`. Especifique o horário no formato `yyyy-MM-ddTHH:mmZ`. O horário deve estar em UTC.
Usage	String	Não	none	Indica se o snapshot foi usado para criar imagens ou discos. Valores válidos: image: o snapshot foi usado para criar imagens personalizadas. disk: o snapshot foi usado para criar discos. image_disk: o snapshot foi usado para criar imagens personalizadas e discos de dados. none: o snapshot não foi usado para criar imagens ou discos.
SourceDiskType	String	Não	Data	O tipo do disco de origem do snapshot. Valores válidos: system: disco do sistema. data: disco de dados. Nota O valor deste parâmetro não diferencia maiúsculas de minúsculas.
Encrypted	Boolean	Não	false	Indica se o snapshot está criptografado. Valor padrão: false.
ResourceGroupId	String	Não	rg-bp67acfmxazb4p****	O ID do grupo de recursos ao qual o snapshot pertence. Se este parâmetro for especificado para consultar recursos, até 1.000 recursos pertencentes ao grupo de recursos especificado serão retornados. Nota Os recursos no grupo de recursos padrão são exibidos na resposta independentemente da configuração deste parâmetro.
DryRun	Boolean	Não	false	Indica se deve ser executada apenas uma simulação, sem realizar a solicitação real. Valores válidos: true: executa apenas uma simulação. O sistema verifica o par de AccessKey, as permissões do usuário RAM e os parâmetros obrigatórios. Se a solicitação falhar na simulação, uma mensagem de erro será retornada. Se a solicitação passar na simulação, o código de erro DryRunOperation será retornado. false (padrão): executa uma simulação e realiza a solicitação real. Se a solicitação passar na simulação, um código de status HTTP 2xx será retornado e a operação será executada.
KMSKeyId	String	Não	0e478b7a-4262-4802-b8cb-00d3fb40****	O ID da chave do Key Management Service (KMS) usada pelo disco de dados.
Category	String	Não	Standard	A categoria do snapshot. Valores válidos: Standard: snapshot normal. Flash: snapshot local. O recurso de snapshot local foi substituído pelo recurso de acesso instantâneo. Ao especificar este parâmetro, observe os seguintes itens: Se você usou snapshots locais antes de 14 de dezembro de 2020, poderá usar este parâmetro. Se você não usou snapshots locais antes de 14 de dezembro de 2020, não poderá usar este parâmetro. Nota Este parâmetro será removido no futuro. Recomendamos o uso de outros parâmetros para garantir compatibilidade futura.
Tag.N.key	String	Não	SnapshotTest	A chave da tag N do snapshot. Nota Este parâmetro será removido no futuro. Recomendamos o uso do parâmetro Tag.N.Key para garantir compatibilidade futura.
Tag.N.Key	String	Não	TestKey	A chave da tag N do snapshot. Valores válidos de N: 1 a 20. Se uma única tag for especificada para consultar recursos, até 1.000 recursos com essa tag serão retornados. Se várias tags forem especificadas, até 1.000 recursos com todas essas tags serão retornados. Para consultar mais de 1.000 recursos com as tags especificadas, chame a operação ListTagResources.
Tag.N.Value	String	Não	TestValue	O valor da tag N do snapshot. Valores válidos de N: 1 a 20.
Tag.N.value	String	Não	SnapshotTest	O valor da tag N do snapshot. Nota Este parâmetro será removido no futuro. Recomendamos o uso de Tag.N.Value para garantir compatibilidade futura.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados.
PageSize	Integer	10	O número de entradas por página.
PageNumber	Integer	1	O número da página.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	O ID da solicitação.
TotalCount	Integer	1	O número total de snapshots retornados.
Snapshots	Array of Snapshot		Os detalhes dos snapshots.
Snapshot
Status	String	accomplished	O estado do snapshot. Valores válidos: progressing accomplished failed
CreationTime	String	2020-08-20T14:52:28Z	O horário em que o snapshot foi criado. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
Progress	String	100%	O progresso da tarefa de criação do snapshot. Unidade: porcentagem (%).
InstantAccess	Boolean	false	Indica se o recurso de acesso instantâneo está ativado. Valores válidos: true: o recurso de acesso instantâneo está ativado. Este recurso só pode ser ativado para SSDs aprimorados (ESSDs). false: o recurso de acesso instantâneo está desativado. O snapshot é um snapshot normal sem o recurso de acesso instantâneo.
Available	Boolean	false	Indica se o snapshot pode ser usado para criar ou restaurar discos. Valores válidos: true: o snapshot pode ser usado para criar ou restaurar discos. false: o snapshot não pode ser usado para criar ou restaurar discos.
RemainTime	Integer	38	O tempo restante para criar o snapshot. Unidade: segundos.
SourceDiskSize	String	40	A capacidade do disco de origem. Unidade: GiB.
RetentionDays	Integer	30	O período de retenção do snapshot automático.
SourceDiskType	String	system	O tipo do disco de origem. Valores válidos: system data
SourceStorageType	String	disk	O tipo do disco de origem. Nota Este parâmetro será removido no futuro. Recomendamos o uso de outros parâmetros para garantir compatibilidade futura.
Usage	String	image	Indica se o snapshot foi usado para criar imagens ou discos. Valores válidos: image disk image_disk none
LastModifiedTime	String	2020-08-25T14:18:09Z	O horário da última modificação do snapshot. O horário segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. O horário é exibido em UTC.
Encrypted	Boolean	false	Indica se o snapshot está criptografado.
SnapshotType	String	all	O tipo do snapshot. Valores válidos: auto ou timer: snapshot automático. user: snapshot manual. all: todos os tipos de snapshot.
SourceDiskId	String	d-bp67acfmxazb4ph****	O ID do disco de origem. Este parâmetro é mantido mesmo após a liberação do disco de origem para o qual o snapshot foi criado.
SnapshotName	String	testSnapshotName	O nome do snapshot. Este parâmetro é retornado apenas se um nome de snapshot tiver sido especificado durante a criação.
InstantAccessRetentionDays	Integer	30	A duração do recurso de acesso instantâneo. O recurso de acesso instantâneo é desativado automaticamente quando a duração especificada expira. Por padrão, o valor deste parâmetro é igual ao de `RetentionDays`.
Description	String	testDescription	A descrição do snapshot.
SnapshotId	String	s-bp67acfmxazb4p****	O ID do snapshot.
ResourceGroupId	String	rg-bp67acfmxazb4p****	O ID do grupo de recursos.
Category	String	standard	A categoria do snapshot. Nota Este parâmetro será removido no futuro. Recomendamos o uso do parâmetro `InstantAccess` para garantir compatibilidade futura.
KMSKeyId	String	0e478b7a-4262-4802-b8cb-00d3fb40****	O ID da chave KMS usada pelo disco de dados.
SnapshotSN	String	64472-116742336-61976****	O número de série do snapshot.
ProductCode	String	jxsc000****	O código do produto da imagem do Alibaba Cloud Marketplace.
SourceSnapshotId	String	s-bp67acfmxazb4p****	O ID do snapshot de origem.
SourceRegionId	String	cn-hangzhou	O ID da região do snapshot de origem.
Tags	Array of Tag		As tags do snapshot.
Tag
TagValue	String	TestValue	O valor da tag do snapshot.
TagKey	String	TestKey	A chave da tag do snapshot.

Exemplos

Exemplos de solicitações

https://ecs.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&InstanceId=i-bp67acfmxazb4p****
&DiskId=d-bp67acfmxazb4p****
&SnapshotIds=["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", ... "s-bp67acfmxazb6p****"]
&PageNumber=1
&PageSize=10
&SnapshotName=testSnapshotName
&Status=all
&SnapshotType=all
&Usage=none
&SourceDiskType=Data
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&Encrypted=false
&DryRun=false
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeSnapshotsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <PageSize>10</PageSize>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <PageNumber>1</PageNumber>
    <Snapshots>
        <Snapshot>
            <Status>accomplished</Status>
            <InstantAccess>false</InstantAccess>
            <Progress>100%</Progress>
            <Available>false</Available>
            <Usage>image</Usage>
            <Description>testDescription</Description>
            <Category>standard</Category>
            <KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
            <ProductCode>jxsc000****</ProductCode>
            <Encrypted>false</Encrypted>
            <SnapshotName>testSnapshotName</SnapshotName>
            <SourceDiskId>d-bp67acfmxazb4ph****</SourceDiskId>
            <SourceStorageType>disk</SourceStorageType>
            <SnapshotId>s-bp67acfmxazb4p****</SnapshotId>
            <SnapshotSN>64472-116742336-61976****</SnapshotSN>
            <SourceDiskSize>40</SourceDiskSize>
            <CreationTime>2020-08-20T14:52:28Z</CreationTime>
            <LastModifiedTime>2020-08-25T14:18:09Z</LastModifiedTime>
            <SnapshotType>all</SnapshotType>
            <SourceDiskType>system</SourceDiskType>
            <Tags>
            </Tags>
        </Snapshot>
    </Snapshots>
</DescribeSnapshotsResponse>

Formato JSON

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

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

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.	Os valores Tag.N.Key e Tag.N.Value não correspondem entre si.
400	InvalidTagCount	The specified tags are beyond the permitted range.	O número máximo de tags foi excedido.
403	InvalidSnapshotIds.Malformed	The amount of specified specified snapshot Ids exceeds the limit.	Formato de SnapshotIds inválido.
403	InvalidSnapshotCategory.Malformed	The specified Category is not valid.	Valor de Category inválido.
404	InvalidFilterKey.NotFound	The specified FilterKey is not found.	A chave de filtro não foi encontrada.
404	InvalidFilterValue	The specified FilterValue exceeds the limit.	Valor de filtro inválido.
404	InvalidUsage	The specifed Usage is not valid.	Valor de Usage inválido.
404	InvalidStatus.NotFound	The specified Status is not found.	Valor de Status inválido.
404	InvalidSnapshotLinkId.NotFound	The specified snapshot link is not found.	O valor SnapshotLinkId não foi encontrado.
500	InternalError	The request processing has failed due to some unknown error.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.