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

Consulta pontos de backup.

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

hbr:ListSnapshots

list

*Todos os recursos.

*

Nenhuma

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 consulta. Ao consultar a próxima página, defina este parâmetro com o valor de NextToken retornado da página anterior. Se NextToken estiver vazio, não existem mais páginas. Este parâmetro não pode ser usado junto com Skip.	eyJJbmRleCI6NjUwMX0=
MaxResults	integer	Não	O número máximo de entradas a serem retornadas para 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 serem ignoradas. O valor deve ser um número inteiro não negativo e um múltiplo de MaxResults. Este parâmetro não pode ser usado junto com NextToken.	0
SourceType	string	Sim	O tipo de fonte de dados. O valor deve ser o mesmo que o tipo de fonte de dados do recurso protegido especificado por ProtectedResourceId. Os tipos de fonte de dados suportados estão descritos nos valores válidos. Valores válidos: NAS : Backup do NAS do Alibaba Cloud. COMMON_FILE_SYSTEM : Backup do CPFS baseado em agente. ECS_FILE : Backup de arquivos do 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 ser o mesmo que o valor do parâmetro SourceType.	pr-123***7890
VaultId	string	Não	O ID do cofre. Este é um filtro opcional. Se você especificar este parâmetro, apenas os pontos de backup no cofre especificado serão retornados.	v-00030j3c******sn
CompleteTimeStart	integer	Não	A hora de início da conclusão. O valor é um carimbo de data/hora UNIX em segundos. Apenas os pontos de backup cuja hora de conclusão seja maior ou igual a este valor são retornados.	1776059082
CompleteTimeEnd	integer	Não	A hora de fim da conclusão. O valor é um carimbo de data/hora UNIX em segundos. Apenas os pontos de backup cuja hora de conclusão seja menor que este valor são retornados.	1776059382
PlanId	string	Não	O ID do plano. Este é um filtro opcional. Se você especificar este parâmetro, 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	Resposta.
Code	string	O código de retorno. Um valor 200 indica sucesso.	200
MaxResults	integer	O número máximo de resultados retornados.	10
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se ocorrer um erro, a mensagem de erro correspondente será retornada.	successful
NextToken	string	O token para a próxima página. Se NextToken estiver vazio, não existem mais páginas.	aWQj********MCMy
RequestId	string	O ID da solicitação.	17189276-**--**-0FF51B5A41A0
Snapshots	array<object>	A lista de pontos de backup.
	object	As informações do ponto de backup.
ActualBytes	integer	A quantidade real de dados gravados, em bytes.	600
ActualItems	integer	O número real de itens.	6
ArchiveTime	integer	A hora em que os dados são arquivados.	1640334062
BackupType	string	O tipo de backup. Um valor COMPLETE indica um backup completo.	COMPLETE
BytesDone	integer	A quantidade de dados com backup realizado, em bytes.	800
BytesTotal	integer	A quantidade total de dados para backup, em bytes.	1000
ClientId	string	O ID do cliente de backup quando o valor de SourceType é ECS_FILE ou File. Em outros casos, este parâmetro indica o ID da fonte de dados de backup.	c-*********************
CompleteTime	integer	A hora de conclusão do backup. O valor é um carimbo de data/hora UNIX em segundos.	1642496679
CreateTime	integer	A hora em que o ponto de backup foi criado, em segundos.	1607436917
CreatedTime	integer	A hora em que o backup foi criado.	1642496679
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
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\"]
ExpireTime	integer	A hora de expiração do backup.	1771901707
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\"]
InstanceId	string	O ID da instância da fonte de dados de backup.	i-*********************
InstanceName	string	O nome da instância do Tablestore.	instancename
ItemsDone	integer	O número de itens com backup realizado.	8
ItemsTotal	integer	O número total de itens para backup.	10
JobId	string	O ID do job de backup.	job-00030j3chkt******2
Path	string	O caminho de backup.	/home
Paths	array	A lista de caminhos de backup.
	string	O caminho de backup.	/home
PlanId	string	O ID do plano de backup.	po-123***7890
ProtectedDataSize	integer	O tamanho dos dados de origem protegidos, em bytes. Quando SourceType é definido como ECS_FILE, este parâmetro indica a capacidade do disco em nuvem protegido.	42949672960
RangeEnd	integer	A hora de fim do job de backup do Tablestore. O valor é um carimbo de data/hora UNIX em milissegundos.	1642521709966
RangeStart	integer	A hora de início do job de backup do Tablestore. O valor é um carimbo de data/hora UNIX em milissegundos.	1642492553038
Retention	integer	O período de retenção do backup, em dias.	7
SnapshotHash	string	O valor de hash do ponto de backup.	f2ac5fd243**********************bc4451777be019
SnapshotId	string	O ID do ponto de backup.	s-00047mxg17p26*****b
SourceType	string	O tipo de fonte de dados. Valores válidos: ECS_FILE: Backup de arquivos do ECS. File: Backup de arquivos locais. OSS: Backup do OSS. NAS: Backup do NAS do Alibaba Cloud. COMMON_NAS: Backup de NAS local. CONTAINER: Backup de contêiner. OTS_TABLE: Backup do Tablestore. COMMON_FILE_SYSTEM: Backup do CPFS baseado em agente. CPFS: Backup do CPFS sem agente.	ECS_FILE
Status	string	O status do ponto de backup. Valores válidos: COMPLETE : Backup concluído. ARCHIVING : Sendo arquivado em segundo plano. PARTIAL_COMPLETE : Backup parcialmente concluído.	COMPLETE
StorageClass	string	A classe de armazenamento. Valores válidos: ARCHIVE : Armazenamento de arquivamento. STANDARD : Armazenamento padrão.	STANDARD
TableName	string	O nome da tabela de dados na instância do Tablestore.	table2
VaultId	string	O ID do cofre que armazena os dados de backup.	v-00030j*******sn
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
TotalCount	integer	O número total de registros.	3

Exemplos

Resposta de sucesso

JSON formato

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

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.