DescribeBackupSetDownloadTaskList - Data Management: Central de Documentação do Alibaba Cloud

Consulta a lista de downloads de conjuntos de backup do DBS.

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

dbs:DescribeBackupSetDownloadTaskList

get

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
BackupPlanId	string	Não	O ID do plano de backup. Você pode chamar a operação DescribeBackupPlanList para consultar o valor deste parâmetro. Nota Você deve especificar BackupPlanId ou BackupSetDownloadTaskId como um parâmetro de solicitação obrigatório.	dbsqhnuhyw3****
BackupSetDownloadTaskId	string	Não	O ID da tarefa de download do conjunto de backup. Backup completo: Você pode chamar a operação CreateFullBackupSetDownload para consultar o valor deste parâmetro. Backup incremental: Você pode chamar a operação CreateIncrementBackupSetDownload para consultar o valor deste parâmetro.	urxgrxt7****
PageSize	integer	Não	O número de entradas por página. Valores válidos: 30, 50 e 100. Nota Valor padrão: 30.	30
PageNum	integer	Não	O número da página. O valor deve ser maior ou igual a 0 e não pode exceder o valor máximo de um número inteiro. Valor padrão: 0.	1
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação e evitar envios duplicados. Você pode inserir qualquer valor.	ETnLKlblzczshOTUbOCzXXXXXX

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os detalhes dos parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
PageNum	integer	O número da página.	0
RequestId	string	O ID da solicitação.	6DC3D286-E0E6-5988-A558-2184984B****
ErrCode	string	O código de erro.	Param.NotFound
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
ErrMessage	string	A mensagem de erro.	The specified parameter %s value is not valid.
TotalPages	integer	O número total de páginas.	1
TotalElements	integer	O número total de registros de download de conjuntos de backup.	1
PageSize	integer	O número de entradas por página.	30
Items	object
BackupSetDownloadTaskDetail	array<object>	Os detalhes do plano de backup.
	object	Os detalhes do plano de backup.
BackupSetDownloadStatus	string	O status de download do conjunto de backup. Valores válidos: checking: pré-verificação init: pré-verificação falhou (não iniciado) check_pass: pré-verificação aprovada pause: pausado schedule: aguardando agendamento running: em execução stop: falhou finish: concluído	finish
BackupSetDataSize	integer	O tamanho dos dados do conjunto de backup.	237837
BackupSetDownloadTargetType	string	O tipo de destino para download do conjunto de backup. Nota Este parâmetro é exibido apenas para downloads automáticos. O valor agent indica que um gateway de backup está instalado.	None
BackupSetDownloadDir	string	O diretório do servidor para download do conjunto de backup. Nota Este parâmetro tem valor apenas para downloads automáticos.	None
ErrMessage	string	A mensagem de exceção.	java.lang.IndexOutOfBoundsException.
BackupSetDownloadCreateTime	integer	O timestamp de criação.	1642044001000
BackupPlanId	string	O ID do plano de backup.	qhnuhyw3****
BackupSetDbType	string	O tipo de banco de dados.	MySQL
BackupSetDownloadInternetUrl	string	A URL de download pública do conjunto de backup. Nota Este parâmetro tem valor apenas para downloads manuais que concluíram a conversão.	"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
BackupSetId	string	O ID do conjunto de backup de origem.	1h7za2yws****
BackupSetDownloadIntranetUrl	string	A URL de download interna do conjunto de backup. Nota Este parâmetro tem valor apenas para downloads manuais que concluíram a conversão.	"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
BackupGatewayId	integer	O gateway de backup do conjunto de backup. Este parâmetro tem valor apenas para downloads automáticos.	None
BackupSetDownloadWay	string	O tipo de download. Valores válidos: manual: manual auto: automático	manual
BackupSetDownloadFinishTime	integer	O timestamp de conclusão.	1642044013000
BackupSetJobType	string	O tipo de tarefa do conjunto de backup de origem. Valores válidos: cbs_backup_sub_full: tarefa de backup completo lógico cbs_backup_sub_cont: tarefa de backup incremental lógico	cbs_backup_sub_cont
BackupSetDownloadTaskId	string	O ID da tarefa de download do conjunto de backup.	urxgrxt7****
BackupSetDownloadTaskName	string	O nome da tarefa de download do conjunto de backup.	1h7za2yws****-ManualCont
BackupSetDataFormat	string	O formato de dados do conjunto de backup baixado. Valores válidos: Native SQL CSV JSON	Native
BackupSetCode	string	O código do conjunto de backup de origem.	mysql-bin.00XXXX

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "无",
        "BackupSetDownloadDir": "无",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	Request.Forbidden	Have no Permissions

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.