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

Consulta os detalhes das instâncias do Tablestore que possuem 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:DescribeOtsTableSnapshots

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
StartTime	integer	Não	A hora de início do backup. O valor deve ser um carimbo de data/hora UNIX. Unidade: milissegundos.	1611109271630
EndTime	integer	Não	A hora de término do backup. O valor deve ser um carimbo de data/hora UNIX. Unidade: milissegundos.	1652068250881
SnapshotIds	array	Não	Os IDs dos snapshots.
	string	Não	O ID do snapshot.	s-00047mxg17p26****3c
OtsInstances	array<object>	Não	As instâncias do Tablestore que possuem backup.
	object	Não	A lista de instâncias do Tablestore que possuem backup.
InstanceName	string	Não	O nome da instância do Tablestore.	instancename
TableNames	array	Não	Os nomes das tabelas na instância do Tablestore.
	string	Não	O nome da tabela na instância do Tablestore.	tablename
Limit	integer	Não	O número máximo de linhas que você deseja que a consulta atual retorne.	100
NextToken	string	Não	O token necessário para obter a próxima página de snapshots de backup.	caeba0bbb2be03f84eb48b699f0a****
CrossAccountType	string	Não	Especifica se os dados são submetidos a backup na mesma conta da Alibaba Cloud ou entre contas da Alibaba Cloud. Valores válidos: SELF_ACCOUNT: Os dados são submetidos a backup na mesma conta da Alibaba Cloud. CROSS_ACCOUNT: Os dados são submetidos a backup entre contas da Alibaba Cloud.	CROSS_ACCOUNT
CrossAccountUserId	integer	Não	O UID da conta de origem usada para backup entre contas.	144015xxxxx98732
CrossAccountRoleName	string	Não	O nome da função do RAM que é criada na conta de origem da Alibaba Cloud e atribuída à conta atual da Alibaba Cloud para autorizar a conta atual da Alibaba Cloud a fazer backup de dados entre contas da Alibaba Cloud.	BackupRole

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	09376812-6290-5E36-B504-E8010D72D1F0
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Code	string	O código de status HTTP. O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.	successful
Limit	integer	O número de snapshots de backup exibidos na página atual.	10
Snapshots	array<object>	Os snapshots de backup.
	object	The list of backup snapshots.
Status	string	O status do job de backup. Valores válidos: COMPLETE: O job de backup foi concluído. PARTIAL_COMPLETE: O job de backup foi parcialmente concluído. FAILED: O job de backup falhou.	COMPLETE
SnapshotHash	string	O valor de hash do snapshot de backup.	f2fe...
VaultId	string	O ID do cofre de backup que armazena o snapshot de backup.	v-00030j*******sn
BackupType	string	O tipo de backup. Valor válido: COMPLETE, que indica backup completo.	COMPLETE
CreateTime	integer	A hora em que a instância do Tablestore foi criada. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1607436917
ActualBytes	string	A quantidade real de dados dos snapshots de backup após a remoção de duplicatas. Unidade: bytes.	0
SourceType	string	O tipo da fonte de dados. Valores válidos: ECS_FILE: snapshots de backup para arquivos do Elastic Compute Service (ECS) OSS: snapshots de backup para buckets do Object Storage Service (OSS) NAS: snapshots de backup para sistemas de arquivos do Apsara File Storage NAS OTS_TABLE: snapshots de backup para instâncias do Tablestore	OTS_TABLE
BytesTotal	integer	A quantidade total de dados. Unidade: bytes.	0
CompleteTime	integer	A hora em que o snapshot de backup foi concluído. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1642496679
Retention	integer	O período de retenção do snapshot de backup. Unidade: dias.	730
CreatedTime	integer	A hora em que o snapshot de backup foi criado. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1642496679
ParentSnapshotHash	string	O valor de hash do snapshot de backup pai.	f2fe..
StartTime	integer	A hora em que o snapshot de backup foi iniciado. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1642496543
UpdatedTime	integer	A hora em que o snapshot de backup foi atualizado. O valor é um carimbo de data/hora UNIX. Unidade: segundos.	1642496679
SnapshotId	string	O ID do snapshot de backup.	s-00047mxg17p26*****b
JobId	string	O ID do job de backup.	job-00030j3chkt******2
InstanceName	string	O nome da instância do Tablestore.	instancename
TableName	string	O nome da tabela na instância do Tablestore.	table2
RangeStart	integer	A hora em que o job de backup foi iniciado. O valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1642492553038
RangeEnd	integer	A hora em que o job de backup foi encerrado. O valor é um carimbo de data/hora UNIX. Unidade: milissegundos.	1642521709966
NextToken	string	O token necessário para obter a próxima página de snapshots de backup.	caeba0bbb2be03f84eb48b699f0a

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "09376812-6290-5E36-B504-E8010D72D1F0",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "Limit": 10,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2fe...",
      "VaultId": "v-00030j*******sn",
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": "0",
      "SourceType": "OTS_TABLE",
      "BytesTotal": 0,
      "CompleteTime": 1642496679,
      "Retention": 730,
      "CreatedTime": 1642496679,
      "ParentSnapshotHash": "f2fe..",
      "StartTime": 1642496543,
      "UpdatedTime": 1642496679,
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a"
}

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.