DescribeBackupTasks - Tair (Redis® OSS-Compatible): Central de Documentação do Alibaba Cloud

Consulta o status de execução dos nós de backup de uma instância de banco de dados ApsaraDB for Tair (compatível com Redis® OSS).

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

kvstore:DescribeBackupTasks

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeInstances para obter o ID da instância.	r-bp1zxszhcgatnx****
BackupJobId	string	Não	O ID da tarefa de backup. Nota Se você chamar a operação CreateBackup para realizar um backup manual, poderá passar o ID de backup retornado para consultar o progresso do backup.	1162****
JobMode	string	Não	O modo de backup. Valores válidos: Automated: backup automático. Você pode chamar a operação DescribeBackupPolicy para consultar a política de backup automático. Manual: backup manual. Nota Por padrão, as informações da tarefa para todos os modos de backup são retornadas. Valores válidos: Automated : Backup automático. Manual : Backup manual.	Manual

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
InstanceId	string	O ID da instância.	r-bp1zxszhcgatnx****
RequestId	string	O ID da solicitação.	BB73740C-23E2-4392-9DA4-2660C74C****
BackupJobs	array<object>	Os detalhes da tarefa de backup.
	object
StartTime	string	A hora de início da tarefa de backup. A hora está no formato yyyy-MM-ddTHH:mm:ssZ. A hora é exibida em UTC.	2021-01-05T19:24:00Z
Process	string	A porcentagem de progresso da tarefa de backup. Este parâmetro não é recomendado. Consulte o parâmetro Progress.	0
JobMode	string	O modo de backup. Valores válidos: Automated: backup automático. Manual: backup manual.	Manual
BackupJobID	integer	O ID da tarefa de backup.	29****10
BackupProgressStatus	string	O status da tarefa de backup. Valores válidos: NoStart: não iniciado Preparing: preparando Waiting: aguardando Uploading: enviando Checking: verificando Finished: concluído	NoStart
NodeId	string	O ID do nó de dados.	****
TaskAction	string	O tipo de tarefa de backup. Valores válidos: TempBackupTask: tarefa de backup temporária, que indica um backup manual NormalBackupTask: tarefa de backup normal, que indica um backup automático	NormalBackupTask
Progress	string	A porcentagem de progresso do backup. Valores válidos: 0 a 100.	27
AccessDeniedDetail	object	Estes parâmetros estão obsoletos. Ignore estes parâmetros.
AuthAction	string	O mesmo que acima.	-
AuthPrincipalDisplayName	string	O mesmo que acima.	-
AuthPrincipalOwnerId	string	O mesmo que acima.	-
AuthPrincipalType	string	O mesmo que acima.	-
EncodedDiagnosticMessage	string	O mesmo que acima.	-
NoPermissionType	string	O mesmo que acima.	-
PolicyType	string	O mesmo que acima.	-

Exemplos

Resposta de sucesso

JSON formato

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "BB73740C-23E2-4392-9DA4-2660C74C****",
  "BackupJobs": [
    {
      "StartTime": "2021-01-05T19:24:00Z",
      "Process": "0",
      "JobMode": "Manual",
      "BackupJobID": 0,
      "BackupProgressStatus": "NoStart",
      "NodeId": "****",
      "TaskAction": "NormalBackupTask",
      "Progress": "27"
    }
  ],
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

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.