ListSnapshots - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta uma lista de pontos de backup.

Descrição da operação

Esta operação consulta uma lista de pontos de backup com base no recurso protegido (ProtectedResourceId). Limites:

O recurso protegido deve existir e SourceType deve corresponder ao tipo de fonte de dados do recurso protegido.
MaxResults deve ser maior que 1. Valor padrão: 10.
Skip deve ser um número inteiro não negativo e um múltiplo de MaxResults. Quando Skip for maior que 0, você não pode especificar NextToken ao mesmo tempo.
CompleteTimeStart e CompleteTimeEnd são timestamps UNIX em segundos. O intervalo de filtro é [CompleteTimeStart, CompleteTimeEnd).
Se nenhum campo de ordenação for especificado, os resultados serão ordenados por hora de conclusão do backup (CompleteTime) em ordem decrescente por padrão.

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
NextToken	string	Não	O token de paginação. Você não precisa especificar este parâmetro na primeira solicitação. Para páginas subsequentes, passe o valor NextToken retornado da solicitação anterior. Um NextToken vazio indica que não há mais páginas disponíveis. Este parâmetro não pode ser usado em conjunto com Skip.	eyJJbmRleCI6NjUwMX0=
MaxResults	integer	Não	O número máximo de resultados a serem retornados em uma consulta paginada. Valor padrão: 10. O valor deve ser maior que 1.	10
Skip	integer	Não	O número de entradas a ignorar. O valor deve ser um inteiro não negativo e um múltiplo de MaxResults. Este parâmetro não pode ser usado em conjunto com NextToken.	0
SourceType	string	Sim	O tipo de fonte de dados. O valor deve corresponder ao tipo de fonte de dados do recurso protegido (ProtectedResourceId). Os tipos de fonte de dados suportados estão listados nos valores válidos. Valores válidos: NAS : Backup do Alibaba Cloud NAS. COMMON_FILE_SYSTEM : Backup do CPFS. ECS_FILE : Backup de arquivos ECS. COMMON_NAS : Backup de NAS local. File : Backup de arquivos locais. OSS : Backup do OSS.	ECS_FILE
ProtectedResourceId	string	Sim	O ID do recurso protegido. O recurso protegido deve existir e seu tipo de fonte de dados deve corresponder ao parâmetro SourceType.	pr-123***7890
VaultId	string	Não	O ID do cofre. Esta é uma condição de filtro opcional. Se especificado, apenas os pontos de backup no cofre especificado serão retornados.	v-00030j3c******sn
CompleteTimeStart	integer	Não	A hora inicial de conclusão. Um timestamp UNIX, em segundos. Apenas pontos de backup com hora de conclusão maior ou igual a este valor são retornados.	1776059082
CompleteTimeEnd	integer	Não	A hora final de conclusão. Um timestamp UNIX, em segundos. Apenas pontos de backup com hora de conclusão anterior a este valor são retornados.	1776059382
PlanId	string	Não	O ID do plano de backup. Esta é uma condição de filtro opcional. Se especificado, apenas os pontos de backup sob o plano de backup especificado serão retornados.	po-0000****123

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	17189276-**--**-0FF51B5A41A0
Code	string	O código de retorno. Um valor de 200 indica sucesso.	200
Message	string	A mensagem de retorno. O valor "successful" é retornado para solicitações bem-sucedidas. Uma mensagem de erro é retornada para solicitações com falha.	successful
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Snapshots	array<object>	A lista de pontos de backup.
	object	As informações do ponto de backup.
Status	string	O status do ponto de backup. Valores válidos: COMPLETE : Backup concluído. ARCHIVING : Arquivamento em segundo plano. PARTIAL_COMPLETE : Backup parcialmente concluído.	COMPLETE
SnapshotHash	string	O valor de hash do ponto de backup.	f2ac5fd243**********************bc4451777be019
VaultId	string	O ID do cofre que armazena os dados de backup.	v-00030j*******sn
ActualItems	integer	O número real de nós.	6
BackupType	string	O tipo de backup. O valor é COMPLETE, que indica um backup completo.	COMPLETE
CreateTime	integer	A hora em que o ponto de backup foi criado, em segundos.	1607436917
ActualBytes	integer	A quantidade real de dados gravados, em bytes.	600
SourceType	string	O tipo de fonte de dados. Valores válidos: ECS_FILE: Backup de arquivos ECS File: Backup de arquivos locais OSS: Backup do OSS NAS: Backup do Alibaba Cloud NAS COMMON_NAS: Backup de NAS local CONTAINER: Backup de contêiner OTS_TABLE: Backup do Tablestore COMMON_FILE_SYSTEM: Backup do CPFS	ECS_FILE
ClientId	string	Quando SourceType está definido como ECS_FILE ou File, este parâmetro indica o ID do cliente de backup. Em outros casos, indica o ID da fonte de dados de backup.	c-*********************
BytesTotal	integer	A quantidade total de dados a serem copiados, em bytes.	1000
ItemsDone	integer	O número de nós que foram copiados.	8
CompleteTime	integer	A hora de conclusão do backup. Um timestamp UNIX, em segundos.	1642496679
Retention	integer	O período de retenção do backup, em dias.	7
CreatedTime	integer	A hora em que o backup foi criado.	1642496679
InstanceId	string	O ID da instância da fonte de dados de backup.	i-*********************
ErrorFile	string	O arquivo que registra informações de falha de backup, incluindo informações sobre backups parcialmente concluídos.	temp/report/123456789/job-xxxxxxxxx_failed.zip
SnapshotId	string	O ID do ponto de backup.	s-00047mxg17p26*****b
JobId	string	O ID do job de backup.	job-00030j3chkt******2
Path	string	O caminho de origem.	/home
ItemsTotal	integer	O número total de nós a serem copiados.	10
BytesDone	integer	A quantidade de dados que foi copiada, em bytes.	800
Paths	array	A lista de caminhos de origem.
	string	O caminho de origem.	/home
InstanceName	string	O nome da instância do Tablestore.	instancename
TableName	string	O nome da tabela de dados na instância do Tablestore.	table2
RangeStart	integer	A hora de início da execução do job de backup do Tablestore. Um timestamp UNIX, em milissegundos.	1642492553038
RangeEnd	integer	A hora de término da execução do job de backup do Tablestore. Um timestamp UNIX, em milissegundos.	1642521709966
ExpireTime	integer	A hora de expiração do backup.	1771901707
StorageClass	string	A classe de armazenamento. Valores válidos: ARCHIVE : Armazenamento de arquivo. STANDARD : Armazenamento padrão.	STANDARD
ArchiveTime	integer	A hora em que o backup foi arquivado.	1640334062
Include	string	Os caminhos de origem incluídos no job de backup.	[\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
Exclude	string	Os caminhos de origem excluídos do job de backup.	[\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
ProtectedDataSize	integer	O tamanho dos dados de origem protegidos, em bytes. Quando SourceType está definido como ECS_FILE, isso indica a capacidade do disco em nuvem protegido.	42949672960
PlanId	string	O ID do plano de backup.	po-123***7890
TotalCount	integer	O número total de registros.	3
MaxResults	integer	O número máximo de resultados retornados.	10
NextToken	string	O token para a próxima página. Um NextToken vazio indica que não há mais páginas disponíveis.	aWQj********MCMy

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "17189276-****-****-****-0FF51B5A41A0",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2ac5fd243**********************bc4451777be019",
      "VaultId": "v-00030j*******sn",
      "ActualItems": 6,
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": 600,
      "SourceType": "ECS_FILE",
      "ClientId": "c-*********************",
      "BytesTotal": 1000,
      "ItemsDone": 8,
      "CompleteTime": 1642496679,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "InstanceId": "i-*********************",
      "ErrorFile": "temp/report/123456789/job-xxxxxxxxx_failed.zip",
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "Path": "/home",
      "ItemsTotal": 10,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966,
      "ExpireTime": 1771901707,
      "StorageClass": "STANDARD",
      "ArchiveTime": 1640334062,
      "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
      "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
      "ProtectedDataSize": 42949672960,
      "PlanId": "po-123***7890"
    }
  ],
  "TotalCount": 3,
  "MaxResults": 10,
  "NextToken": "aWQj********MCMy"
}

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.