ListSnapshots - Simple Application Server: Central de Documentação do Alibaba Cloud

Consulta as informações de um ou mais snapshots criados.

Descrição da operação

InstanceId, DiskId, SnapshotIds e ResourceGroupId não são parâmetros de solicitação obrigatórios, mas você pode usá-los para construir lógicas de filtro. Esses parâmetros possuem uma relação lógica AND.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

swas-open:ListSnapshots

get

*Snapshot.

acs:swas-open:{#regionId}:{#accountId}:snapshot/*

*Snapshot.

acs:swas-open:{#regionId}:{#accountId}:snapshot/{#SnapshotId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do Simple Application Server ao qual o snapshot pertence.	cn-hangzhou
InstanceId	string	Não	O ID da instância do Simple Application Server.	2ad1ae67295445f598017499dc****
DiskId	string	Não	O ID do disco.	d-bp14wq0149cpp2xy****
SnapshotIds	string	Não	Os IDs dos snapshots. O valor pode ser uma matriz JSON que consiste em até 100 IDs de snapshots. Separe vários IDs com vírgulas (,).	["s-bp16oazlsold4dks**", "s-bp16oazlsold4abc**"]
PageSize	integer	Não	O número de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
PageNumber	integer	Não	O número da página da lista de snapshots. Valor padrão: 1.	1
SourceDiskType	string	Não	O tipo do disco em nuvem de origem do snapshot. Valores válidos: System: disco em nuvem do sistema. Data: disco em nuvem de dados.	Data
Tag	array<object>	Não	As tags do snapshot.
	object	Não	A tag.
Key	string	Não	A chave da tag do snapshot. A chave da tag deve ter de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestKey
Value	string	Não	O valor da tag do snapshot. O valor da tag deve ter de 1 a 64 caracteres. Valores válidos de N: 1 a 20.	TestValue
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2bti7cf7****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de snapshots.	1
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F534F
PageSize	integer	O número de entradas por página para uma consulta paginada.	10
PageNumber	integer	O número da página da lista de snapshots.	1
Snapshots	array<object>	As informações 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: Falha ao criar o snapshot. disabled: O rollback não é suportado.	Accomplished
CreationTime	string	A hora em que o snapshot foi criado. A hora segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-03-09T07:12:49Z
SourceDiskId	string	O ID do disco de origem. Este valor é retido mesmo que o disco de origem do snapshot tenha sido liberado.	d-bp14wq0149cpp2xy****
SnapshotName	string	O nome do snapshot.	test-SnapshotName
Progress	string	O progresso da criação do snapshot.	100%
Remark	string	As observações do snapshot.	test-Remark
SnapshotId	string	O ID do snapshot.	s-bp16oazlsold4dks****
SourceDiskType	string	O tipo do disco de origem do snapshot. Valores válidos: System: disco em nuvem do sistema. Data: disco em nuvem de dados.	System
RegionId	string	O ID da região.	cn-hangzhou
InstanceId	string	O ID da instância do Simple Application Server. Nota: Este campo tem um valor para snapshots de disco em nuvem do sistema e está vazio para snapshots de disco em nuvem de dados.	2ad1ae67295445f598017499dc****
Tags	array<object>	As tags do snapshot.
	object	A tag.
Key	string	A chave da tag do snapshot.	TestKey
Value	string	O valor da tag do snapshot.	TestValue
RollbackTime	string	A hora do rollback mais recente. A hora está no fuso horário UTC (Z) no formato YYYY-MM-DDThh:mm:ssZ.	2021-03-09T07:12:49Z
ResourceGroupId	string	O ID do grupo de recursos ao qual o snapshot pertence.	rg-aek2bti7cf7****

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "CreationTime": "2021-03-09T07:12:49Z",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "SnapshotName": "test-SnapshotName",
      "Progress": "100%",
      "Remark": "test-Remark",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "SourceDiskType": "System",
      "RegionId": "cn-hangzhou",
      "InstanceId": "2ad1ae67295445f598017499dc****",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ],
      "RollbackTime": "2021-03-09T07:12:49Z",
      "ResourceGroupId": "rg-aek2bti7cf7****"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	RegionIdNotMatchHost	The parameter regionId does not match the endpoint host.
400	InvalidSnapshotIds	The specified SnapshotIds is not valid.
500	InternalError	An error occurred while processing your request.
403	InvalidParam	The specified parameter value is invalid.
404	InvalidInstanceId.NotFound	The specified InstanceId does not exist.
404	InvalidDiskId.NotFound	The specified DiskId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.