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

Consulta os snapshots de backup criados para antirransomware.

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

yundun-sas:DescribeSnapshots

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Uuid	string	Não	O UUID do servidor. Nota Você pode chamar a operação DescribeBackupPolicy para consultar os UUIDs dos servidores.	061d8042-59ff-416e-bc33-294a1cf5****
MachineRegion	string	Não	A região na qual o servidor reside. Nota Se o parâmetro Uuid não for especificado, este parâmetro é obrigatório.	us-east-1
MachineRemark	string	Não	O nome ou endereço IP do servidor.	192.168.XX.XX
StatusList	string	Não	O status dos snapshots de backup a partir dos quais os dados podem ser restaurados. Valores válidos: COMPLETE: completo PARTIAL_COMPLETE: parcialmente completo	["COMPLETE"]
PageSize	integer	Sim	O número de entradas a serem retornadas em cada página.	20
CurrentPage	integer	Não	O número da página a ser retornada. Valor padrão: 1.	1
NextToken	string	Não	A posição inicial da consulta. Se este parâmetro for deixado vazio, a consulta começará do início. Nota Se você chamar a operação pela primeira vez, não precisará especificar o parâmetro. A resposta da primeira chamada contém o token que pode ser usado para a segunda chamada. Cada resposta subsequente contém o token que pode ser usado para a próxima chamada.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAB4SwmEAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM0NzY3YTZjNjI3NjZmNmU3MjcxNjk3NDY5MzY3MjY4****
ApiVersion	string	Sim	A versão da política antirransomware. Valores válidos: 1.0.0 2.0.0	2.0.0
IsAliYunEcs	string	Não	Especifica se o servidor é uma instância do Elastic Compute Service (ECS). Valores válidos: true: sim false: não	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados retornados.
RequestId	string	O ID da solicitação, que é usado para localizar e solucionar problemas.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****
PageInfo	object	As informações de paginação.
CurrentPage	integer	O número da página retornada.	1
NextToken	string	O token usado para iniciar a próxima chamada.	CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****
PageSize	integer	O número de entradas retornadas por página.	20
TotalCount	integer	O número total de entradas retornadas.	149
Count	integer	O número de entradas retornadas na página atual.	20
Snapshots	array<object>	Um array composto pelos snapshots de backup.
	object	As informações sobre o snapshot de backup.
Status	string	O status das tarefas de backup. Valores válidos: COMPLETE: completo PARTIAL_COMPLETE: parcialmente completo FAILED: com falha	COMPLETE
SnapshotHash	string	O valor de hash do snapshot de backup.	9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****
ActualItems	integer	O número real de objetos de backup. Nota Este parâmetro está disponível apenas para backup de arquivos.	123
VaultId	string	O ID do cofre de backup que armazena o snapshot de backup.	v-000ccok3zmw7fbzz****
ActualBytes	integer	A quantidade real de dados dos snapshots de backup após a remoção de duplicatas. Unidade: bytes.	686188****
SourceType	string	O tipo da fonte de dados. Valores válidos: ECS_FILE: arquivos do ECS OSS: buckets do Object Storage Service (OSS) NAS: sistemas de arquivos do File Storage NAS OTS_TABLE: instâncias do Tablestore	ECS_FILE
ClientId	string	Este parâmetro é retornado apenas se o valor do parâmetro SourceType for ECS_FILE. Este parâmetro indica o ID do agente do Hybrid Backup Recovery (HBR).	c-000dbefaw9f7gnbw****
ItemsDone	integer	O número de objetos de backup. Nota Este parâmetro está disponível apenas para backup de arquivos.	6
BytesTotal	integer	A quantidade total de dados da fonte de dados. Unidade: bytes.	3484541815****
Retention	integer	O período de retenção do snapshot de backup.	7
CreatedTime	integer	A hora em que o snapshot de backup foi criado. O valor é um timestamp UNIX. Unidade: segundos.	1646793988
ParentSnapshotHash	string	O valor de hash do snapshot de backup pai.	a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****
InstanceId	string	O ID da instância ECS.	i-2ze78zfakirgh1yl****
PlanId	string	O ID do plano de backup.	plan-000ee8gh2ljelsnb****
RegionId	string	O ID da região na qual o snapshot de backup está armazenado.	us-east-1
Uuid	string	O UUID do servidor.	d332af48-1269-4a55-a6db-8543a80f****
ErrorFile	string	O arquivo que registra as informações sobre falhas de backup, incluindo as informações sobre tarefas de backup parcialmente concluídas.	s-0008ndhgrflh55i5****.csv
SnapshotId	string	O ID do snapshot de backup.	s-0003ahfuqpjdztsg****
JobId	string	O ID da tarefa de backup.	job-000a2q5vg6awgo01****
Path	string	Este parâmetro é retornado apenas se o valor do parâmetro SourceType for ECS_FILE. Este parâmetro indica o caminho para os arquivos de backup.	["/home"]
ItemsTotal	integer	O número total de objetos na fonte de dados. Nota Este parâmetro está disponível apenas para backup de arquivos.	7
BytesDone	integer	A quantidade real de dados gerada pelo backup incremental. Unidade: bytes.	800
Paths	array	Este parâmetro é retornado apenas se o valor do parâmetro SourceType for NAS. Este parâmetro indica o caminho para os arquivos de backup.
	string	As informações de caminho sobre o snapshot de backup.	/home
ClientVersion	string	A versão do agente antirransomware.	2.10.0
ExpireTime	integer	O timestamp de expiração do snapshot. Unidade: milissegundos.	1799132915000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB393****",
  "PageInfo": {
    "CurrentPage": 1,
    "NextToken": "CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJAGYXFWIAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM1Mzc3Njc4MzA2ODY5NmI2YTY1Nzg2NTcxNjE2NDc4****",
    "PageSize": 20,
    "TotalCount": 149,
    "Count": 20
  },
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "9ee47cf12351e4ddecce8c12f4957d3946cd96fbe24cd4ab264c7200839d****",
      "ActualItems": 123,
      "VaultId": "v-000ccok3zmw7fbzz****",
      "ActualBytes": 0,
      "SourceType": "ECS_FILE",
      "ClientId": "c-000dbefaw9f7gnbw****",
      "ItemsDone": 6,
      "BytesTotal": 0,
      "Retention": 7,
      "CreatedTime": 1646793988,
      "ParentSnapshotHash": "a0181606689c9562f092b3190bddb8a62bb5a24784424ba2102bc7fe92ae****",
      "InstanceId": "i-2ze78zfakirgh1yl****",
      "PlanId": "plan-000ee8gh2ljelsnb****",
      "RegionId": "us-east-1",
      "Uuid": "d332af48-1269-4a55-a6db-8543a80f****",
      "ErrorFile": "s-0008ndhgrflh55i5****.csv",
      "SnapshotId": "s-0003ahfuqpjdztsg****",
      "JobId": "job-000a2q5vg6awgo01****",
      "Path": "[\"/home\"]\n",
      "ItemsTotal": 7,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "ClientVersion": "2.10.0",
      "ExpireTime": 1799132915000
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	ServerError	ServerError
403	NoPermission	caller has no permission

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.