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

Consulta uma lista de tarefas de download avançadas para instâncias RDS for MySQL, RDS for PostgreSQL e PolarDB for MySQL.

Descrição da operação

Mecanismos aplicáveis

Instâncias ApsaraDB RDS for MySQL que utilizam discos em nuvem
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL
MongoDB

Documentos relacionados

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:DescribeDownloadTask

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionCode	string	Sim	O ID da região onde a instância reside. Para obter o ID da região, chame DescribeDBInstanceAttribute.	cn-hangzhou
InstanceName	string	Não	O ID da instância. Nota Este parâmetro é obrigatório.	rm-bp1imnmcjxdz7****
DatasourceId	string	Não	O ID da fonte de dados no DBS. O formato é: ds-${ID da instância}_${ID da região}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	Não	O ID do conjunto de backup. Para obter o ID do conjunto de backup, chame DescribeBackups.	216****
State	string	Não	O estado da tarefa de download. Valores válidos: initializing: A tarefa está sendo inicializada. queueing: A tarefa está em uma fila. running: A tarefa está em execução. failed: A tarefa falhou. finished: A tarefa foi bem-sucedida. expired: O download expirou.	queueing
TaskType	string	Não	O tipo da tarefa de download. Valores válidos: full: download do conjunto de backup completo. pitr: download de recuperação point-in-time.	full
StartTime	string	Não	O início do intervalo de tempo para consultar tarefas com base na hora de criação. Este é um timestamp UNIX em milissegundos (ms).	1661941554000
EndTime	string	Não	O fim do intervalo de tempo para consultar tarefas com base na hora de criação. Este é um timestamp UNIX em milissegundos (ms).	1661941556000
PageSize	string	Não	O número de entradas a serem retornadas em cada página.	50
CurrentPage	string	Não	O número da página.	1
OrderDirect	string	Não	A direção de ordenação. Valores válidos: asc: ordem crescente. desc: ordem decrescente. Este é o valor padrão.	desc
OrderColumn	string	Não	O campo usado para ordenação. O valor padrão é gmt_create, que indica a hora de criação.	gmt_create
ClusterName	string	Não	O nome do cluster fragmentado. Este parâmetro é obrigatório apenas para instâncias MongoDB.	dds-example

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros retornados.
RequestId	string	O ID da solicitação.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	O código de erro.	DBS.InternalError
Success	string	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.	instanceName can not be empty
Code	string	O código de erro.	DBS.InternalError
Message	string	A mensagem de erro.	instanceName can not be empty
Data	object	Os detalhes da tarefa.
PageNumber	integer	O número da página. Deve ser maior que 0 e não exceder o valor máximo do tipo de dados inteiro. Valor padrão: 1.	1
TotalPages	integer	O número total de páginas.	2
Extra	string	Informações adicionais sobre a tarefa usada para fazer backup de dados na nuvem.	dbtest
TotalElements	integer	O número total de tarefas de download.	1
PageSize	integer	O número de entradas retornadas por página.	10
Content	object
List	array<object>	The task details.
	object	The task details.
TaskId	string	The download task ID.	dt-qxntlvgu****
RegionCode	string	The region ID.	cn-hangzhou
Format	string	The destination format to which the downloaded data is converted. Valid values: csv SQL Parquet	csv
DbList	string	The list of databases.	[dbtest]
BakSetId	string	The ID of the full backup set.	148261****
DownloadStatus	string	The state of the download task. Valid values: initializing: The task is being initialized. queueing: The task is in a queue. running: The task is running. failed: The task failed. finished: The task is successful. expired: The download has expired.	queueing
ExportDataSize	string	The volume of exported data, in bytes.	0
ImportDataSize	string	The volume of processed data, in bytes.	0
BackupSetTime	string	The point in time of the point-in-time download task. This is a UNIX timestamp in milliseconds (ms).	1663162216000
TargetType	string	The type of the download destination. Valid values: OSS URL	URL
TargetPath	string	The destination path of the downloaded data. This parameter is returned when TargetType is set to OSS.	test_db/path
Progress	string	The number of exported tables/The total number of tables to be exported.	0/0
GmtCreate	string	The time when the task was created. This is a UNIX timestamp in milliseconds.	1663321957000

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": {
      "List": [
        {
          "TaskId": "dt-qxntlvgu****",
          "RegionCode": "cn-hangzhou",
          "Format": "csv",
          "DbList": "[dbtest]",
          "BakSetId": "148261****",
          "DownloadStatus": "queueing",
          "ExportDataSize": "0",
          "ImportDataSize": "0",
          "BackupSetTime": "1663162216000",
          "TargetType": "URL",
          "TargetPath": "test_db/path",
          "Progress": "0/0",
          "GmtCreate": "1663321957000"
        }
      ]
    }
  }
}

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.