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

Cria uma tarefa de download avançado.

Descrição da operação

Mecanismos compatíveis

RDS MySQL (instâncias com disco em nuvem)
RDS PostgreSQL
PolarDB for MySQL
ApsaraDB for MongoDB

Documentação relacionada

Para instâncias elegíveis, você pode criar uma tarefa de download avançado para um conjunto de backups específico ou para qualquer ponto no tempo. Você pode definir o destino do download como uma URL ou gravar os dados diretamente no seu bucket do Object Storage Service (OSS) para análise de dados e arquivamento offline.

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

create

*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 em que a instância está localizada. Você pode chamar a operação DescribeDBInstanceAttribute para uma instância do ApsaraDB RDS ou a operação DescribeDBClusterAttribute para um cluster do PolarDB para consultar o ID da região.	cn-beijing
InstanceName	string	Sim	O ID da instância.	rm-wz994c1t1****
BakSetType	string	Não	O tipo da tarefa de download. Valores válidos: full: Baixa um conjunto de backups completo. pitr: Baixa dados de um ponto no tempo.	full
BakSetId	string	Não	O ID do conjunto de backups. Você pode chamar a operação DescribeBackups para uma instância do ApsaraDB RDS ou a operação DescribeBackups para um cluster do PolarDB para obter o ID do conjunto de backups. Nota Este parâmetro é obrigatório se `BakSetType` estiver definido como `full`.	146005****
DownloadPointInTime	string	Não	O ponto no tempo para o download. Especifique um carimbo de data/hora Unix em milissegundos (ms). Nota Este parâmetro é obrigatório se `BakSetType` estiver definido como `pitr`.	1661331864000
BakSetSize	string	Não	O tamanho do conjunto de backups completo, em bytes. Você pode chamar a operação DescribeBackups para uma instância do ApsaraDB RDS ou a operação DescribeBackups para um cluster do PolarDB para consultar o tamanho.	216****
FormatType	string	Não	O formato de destino dos dados baixados. Valores válidos: CSV SQL Parquet Bson qp.xb Nota Este parâmetro é obrigatório. O formato `Bson` está disponível apenas para instâncias do MongoDB. O formato `qp.xb` está disponível apenas para instâncias do ApsaraDB RDS for MySQL. Valores válidos: qp.xb : qp.xb csv : CSV. bson : Bson. csv-with-header : csv-with-header. parquet : Parquet. sql : SQL.	CSV
TargetType	string	Não	O tipo de destino para o download. Valores válidos: OSS URL	OSS
TargetBucket	string	Não	O nome do bucket do OSS de destino. Este parâmetro é obrigatório se `TargetType` estiver definido como `OSS`. Certifique-se de que sua conta tenha a função AliyunDBSDefaultRole concedida. Para obter mais informações, consulte Conceder permissões a uma função do RAM. Você também pode conceder a função no console seguindo as instruções na tela.	test123
TargetPath	string	Não	O caminho de destino para os dados baixados. Nota Este parâmetro é obrigatório se `TargetType` estiver definido como `OSS`.	test_db/path
TargetOssRegion	string	Não	A região em que o bucket do OSS de destino está localizado. Nota Este parâmetro é obrigatório se `TargetType` estiver definido como `OSS`.	cn-beijing
PrimaryKeyTypeOnly	string	Não	Este parâmetro é obrigatório apenas para instâncias do MongoDB. Especifica se a chave primária em uma tabela é única. Defina o valor como `true` se a chave primária for única, ou `false` caso contrário.	false
IsCluster	string	Não	Este parâmetro é obrigatório apenas para instâncias do MongoDB. Defina o valor como `true` se a instância for um cluster sharded, ou `false` caso contrário.	false
AdminDatabase	string	Não	Este parâmetro é obrigatório apenas para instâncias do MongoDB. Especifica o nome do banco de dados de autenticação. O valor padrão é `admin`.	admin
UseZstd	string	Não	Especifica se deve ser usado o algoritmo de compactação zstd. Valor padrão: `false`.	false
ClusterName	string	Não	Este parâmetro é obrigatório apenas para clusters sharded do MongoDB. Especifica o ID do cluster sharded.	dds-0xid8e5336******
IsPhysical	boolean	Não	Este parâmetro é obrigatório apenas quando você baixa dados no formato `qp.xb` de uma instância do ApsaraDB RDS for MySQL. Nesse caso, defina o valor como `true`.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
RequestId	string	O ID da solicitação.	A08F908D-2C35-583F-93C1-ED80753F****
ErrCode	string	O código de erro.	DBS.ParamIsInValid
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.	formatType can not be empty
Code	string	O código de status.	DBS.ParamIsInValid
Message	string	A mensagem de erro.	formatType can not be empty
Data	object	Os detalhes da tarefa de download.
BakSetId	string	O ID do conjunto de backups completo.	146005****
DownloadStatus	string	O status da tarefa de download. Valores válidos: initializing: A tarefa está inicializando. queueing: A tarefa está na fila. running: A tarefa está em execução. failed: A tarefa falhou. finished: A tarefa foi concluída. expired: A tarefa expirou. Nota Se o destino do download for uma URL, o link expira três dias após a conclusão da tarefa.	initializing
Progress	string	O número de tabelas baixadas em relação ao número total de tabelas. Nota Se a tarefa estiver inicializando, `0/0` será retornado.	0/0
BackupSetTime	integer	O ponto no tempo do conjunto de backups, retornado como um carimbo de data/hora Unix em milissegundos.	1661373070000
RegionCode	string	O ID da região.	cn-beijing
TargetPath	string	O caminho de destino para o download de dados. Nota Este parâmetro é retornado apenas quando `TargetType` é `OSS`.	test_db/path
DbList	string	Se o download for para bancos de dados ou tabelas específicas, este parâmetro lista seus nomes.	testdb
ExportDataSize	integer	O tamanho dos dados exportados, em bytes.	0
ImportDataSize	integer	O tamanho dos dados processados, em bytes.	0
GmtCreate	integer	A hora de criação da tarefa, retornada como um carimbo de data/hora Unix em milissegundos.	1661940917570
TaskId	string	O ID da tarefa de download.	dt-qxnsfq5s****
Format	string	O formato para o qual os dados são convertidos.	CSV
TargetType	string	O tipo de destino para o download.	URL

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A08F908D-2C35-583F-93C1-ED80753F****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "formatType can not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "formatType can not be empty",
  "Data": {
    "BakSetId": "146005****",
    "DownloadStatus": "initializing",
    "Progress": "0/0",
    "BackupSetTime": 1661373070000,
    "RegionCode": "cn-beijing",
    "TargetPath": "test_db/path",
    "DbList": "testdb",
    "ExportDataSize": 0,
    "ImportDataSize": 0,
    "GmtCreate": 1661940917570,
    "TaskId": "dt-qxnsfq5s****",
    "Format": "CSV",
    "TargetType": "URL"
  }
}

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.

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
200	DBS.DownloadTask.CannotFind	Can not find download task.	Can not find download task.
200	DBS.DownloadTask.JobAlreadyExist	Job already submit in recent days, please check it.	Job already submit in recent days, please check it.
200	DBS.DownloadTask.OnlyOneRunningOrFailedTask	There can be only one running or failed task for the instance.	The current instance can only have one running/failed task at the same time.
200	DBS.DownloadTask.OssForbid	OSS is forbidden to access. Please check your OSS bucket.	OSS is forbidden to access. Please check your OSS bucket.
200	DBS.DownloadTask.OssStorageTypeInvalid	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.
200	Forbidden.InstanceNotFound	instance not found	The instance does not exist.
200	DBS.DownloadTask.BakSetError	DBS download task bak set error. Your backup set does not meet the requirements.	Your backup set does not meet the requirements.
200	DBS.DownloadTask.CustinIdNotSupport	DBS DownloadTask CustinIdNotSupport.	DBS DownloadTask CustinIdNotSupport.
200	DBS.DownloadTask.CustinNameNotSupport	DBS DownloadTask CustinNameNotSupport.	DBS DownloadTask CustinNameNotSupport.
200	DBS.DownloadTask.DbTypeNotSupport	DBS DownloadTask DbTypeNotSupport.	DBS DownloadTask DbTypeNotSupport.
200	DBS.DownloadTask.InstanceInfoNotSupport	DBS DownloadTask InstanceInfoNotSupport.	DBS DownloadTask InstanceInfoNotSupport.
200	DBS.DownloadTask.InstanceParamNotSupport	DBS DownloadTask InstanceParamNotSupport.	DBS DownloadTask InstanceParamNotSupport.
200	DBS.DownloadTask.InstanceStorageTypeNotSupport	DBS DownloadTask InstanceStorageTypeNotSupport.
200	DBS.DownloadTask.InstanceVersionNotSupport	DBS DownloadTask InstanceVersionNotSupport.	DBS DownloadTask InstanceVersionNotSupport.
200	DBS.DownloadTask.NotSupport	DBS DownloadTask NotSupport.	DBS DownloadTask NotSupport.
200	DBS.DownloadTask.RegionNotSupport	DBS DownloadTask RegionNotSupport.	DBS DownloadTask RegionNotSupport.
200	DBS.DownloadTask.UserNotSupport	DBS DownloadTask UserNotSupport.	DBS DownloadTask UserNotSupport.
403	Request.Forbidden	Have no Permissions
403	DBS.NoPermissionException	Rejected by ValidationChecker.
404	DBS.NotExists	data source do not existed.	DBS.NotExists