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

Consulta informações sobre um ou mais snapshots de um sistema de arquivos especificado.

Descrição da operação

Este recurso está em preview público gratuito. Durante o preview público, o Acordo de Nível de Serviço (SLA) do File Storage NAS não é garantido.
Apenas sistemas de arquivos Extreme NAS Avançado suportam este recurso.

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

nas:DescribeSnapshots

get

*Snapshot

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileSystemType	string	Não	O tipo de sistema de arquivos. Valores válidos: extreme (sistema de arquivos Extreme NAS) Valores válidos: extreme : Sistema de arquivos Extreme NAS.	extreme
FileSystemId	string	Não	O ID do sistema de arquivos.	extreme-22f****
SnapshotIds	string	Não	Os IDs dos snapshots. Você pode especificar vários IDs de snapshots separados por vírgulas (,). O limite máximo é de 100 IDs.	s-extreme-67pxwk9aevrkr**,s-extreme-snapsho,s-extreme-6tmsbas6ljhwh**
SnapshotName	string	Não	O nome do snapshot.	FinanceJoshua
SnapshotType	string	Não	O tipo de snapshot. Valores válidos: auto: snapshot automático user: snapshot criado manualmente all (padrão): todos os tipos de snapshot Valores válidos: all : todos os tipos de snapshot. auto : snapshot automático. user : snapshot criado manualmente.	all
Status	string	Não	O status 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): todos os status de snapshot Valores válidos: all : todos os status de snapshot. accomplished : O snapshot foi criado. progressing : O snapshot está sendo criado. failed : Falha na criação do snapshot.	all
PageSize	integer	Não	O número de entradas por página em uma consulta paginada. Configurações para o número de linhas por página na paginação. Valores válidos: 1 a 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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
TotalCount	integer	O número total de snapshots.	36
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageSize	integer	O número de entradas por página.	10
PageNumber	integer	O número da página da lista de snapshots.	1
Snapshots	object
Snapshot	array<object>	Os detalhes do snapshot.
	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.	accomplished
Progress	string	O progresso da criação do snapshot. O valor deste parâmetro é expresso em porcentagem.	100
CreateTime	string	A hora em que o snapshot foi criado. A hora segue o padrão ISO 8601 em UTC. A hora é exibida no formato `yyyy-MM-ddThh:mmZ`.	2014-07-24T13:00:52Z
SourceFileSystemId	string	O ID do sistema de arquivos de origem. Este parâmetro é mantido mesmo que o sistema de arquivos de origem do snapshot seja excluído.	extreme-012****
RetentionDays	integer	O período de retenção do snapshot automático. Unidade: dias. Valores válidos: -1: Os snapshots automáticos são retidos permanentemente. Depois que o número de snapshots automáticos excede o limite superior, o snapshot automático mais antigo é excluído automaticamente. 1 a 65536: Os snapshots automáticos são retidos pelos dias especificados. Após o término do período de retenção dos snapshots automáticos, eles são excluídos automaticamente.	30
RemainTime	integer	O tempo restante necessário para criar o snapshot. Unidade: segundos.	38
SourceFileSystemSize	integer	A capacidade do sistema de arquivos de origem. Unidade: GiB.	2000
SourceFileSystemVersion	string	A versão do sistema de arquivos de origem.	1
SnapshotName	string	O nome do snapshot. Se você especificar um nome para criar um snapshot, o nome do snapshot será retornado. Caso contrário, nenhum valor será retornado para este parâmetro.	FinanceJoshua
EncryptType	integer	Indica se o snapshot está criptografado. Valores válidos: 0: O snapshot não está criptografado. 1: O snapshot está criptografado.	1
Description	string	A descrição do snapshot.	FinanceDept
SnapshotId	string	O ID do snapshot.	s-extreme-snapsho****
FileSystemType	string	O tipo do sistema de arquivos.	extreme
SnapshotType	string	O tipo do snapshot. Valores válidos: auto: snapshots criados automaticamente user: snapshots criados manualmente	user
CompletedTime	string	A hora em que a criação do snapshot foi concluída. A hora segue o padrão ISO 8601 em UTC. A hora é exibida no formato `yyyy-MM-ddThh:mmZ`. Nota Este parâmetro é válido somente quando o snapshot é criado. Durante a criação do snapshot, o valor deste parâmetro é o mesmo que o de CreateTime.	2014-07-24T13:10:52Z

Exemplos

Resposta de sucesso

JSON formato

{
  "TotalCount": 36,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "accomplished",
        "Progress": "100",
        "CreateTime": "2014-07-24T13:00:52Z",
        "SourceFileSystemId": "extreme-012****",
        "RetentionDays": 30,
        "RemainTime": 38,
        "SourceFileSystemSize": 2000,
        "SourceFileSystemVersion": "1",
        "SnapshotName": "FinanceJoshua",
        "EncryptType": 1,
        "Description": "FinanceDept",
        "SnapshotId": "s-extreme-snapsho****",
        "FileSystemType": "extreme",
        "SnapshotType": "user",
        "CompletedTime": "2014-07-24T13:10:52Z"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.