CreateDownload - Data Management - Centro de documentación de Alibaba Cloud

Crea una tarea de descarga avanzada.

Descripción de la operación

Motores compatibles

RDS MySQL (instancias con disco en la nube)
RDS PostgreSQL
PolarDB for MySQL
ApsaraDB for MongoDB

Documentación relacionada

Para las instancias elegibles, puede crear una tarea de descarga avanzada para un conjunto de copias de seguridad específico o para cualquier punto en el tiempo. Puede configurar el destino de descarga como una URL o escribir los datos directamente en su bucket de Object Storage Service (OSS) para análisis de datos y archivado sin conexión.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dbs:CreateDownload

create

*DBInstance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionCode	string	Sí	El ID de la región donde se encuentra la instancia. Puede llamar a la operación DescribeDBInstanceAttribute para una instancia de ApsaraDB RDS o a la operación DescribeDBClusterAttribute para un clúster de PolarDB a fin de consultar el ID de la región.	cn-beijing
InstanceName	string	Sí	El ID de la instancia.	rm-wz994c1t1****
BakSetType	string	No	El tipo de tarea de descarga. Valores válidos: full: descarga un conjunto de copias de seguridad completas. pitr: descarga datos desde un punto en el tiempo.	full
BakSetId	string	No	El ID del conjunto de copias de seguridad. Puede llamar a la operación DescribeBackups para una instancia de ApsaraDB RDS o a la operación DescribeBackups para un clúster de PolarDB a fin de obtener el ID del conjunto de copias de seguridad. Nota Este parámetro es obligatorio si `BakSetType` se establece en `full`.	146005****
DownloadPointInTime	string	No	El punto en el tiempo para la descarga. Especifique una marca de tiempo Unix en milisegundos (ms). Nota Este parámetro es obligatorio si `BakSetType` se establece en `pitr`.	1661331864000
BakSetSize	string	No	El tamaño del conjunto de copias de seguridad completas, en bytes. Puede llamar a la operación DescribeBackups para una instancia de ApsaraDB RDS o a la operación DescribeBackups para un clúster de PolarDB a fin de consultar el tamaño.	216****
FormatType	string	No	El formato de destino de los datos descargados. Valores válidos: CSV SQL Parquet Bson qp.xb Nota Este parámetro es obligatorio. El formato `Bson` solo está disponible para instancias de MongoDB. El formato `qp.xb` solo está disponible para instancias de 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	No	El tipo de destino para la descarga. Valores válidos: OSS URL	OSS
TargetBucket	string	No	El nombre del bucket de OSS de destino. Este parámetro es obligatorio si `TargetType` se establece en `OSS`. Asegúrese de que a su cuenta se le haya otorgado el rol AliyunDBSDefaultRole. Para obtener más información, consulte Otorgar permisos a un rol de RAM. También puede otorgar el rol en la consola siguiendo las instrucciones en pantalla.	test123
TargetPath	string	No	La ruta de destino para los datos descargados. Nota Este parámetro es obligatorio si `TargetType` se establece en `OSS`.	test_db/path
TargetOssRegion	string	No	La región donde se encuentra el bucket de OSS de destino. Nota Este parámetro es obligatorio si `TargetType` se establece en `OSS`.	cn-beijing
PrimaryKeyTypeOnly	string	No	Este parámetro solo es obligatorio para instancias de MongoDB. Especifica si la clave principal en una tabla es única. Establezca el valor en `true` si la clave principal es única, o en `false` en caso contrario.	false
IsCluster	string	No	Este parámetro solo es obligatorio para instancias de MongoDB. Establezca el valor en `true` si la instancia es un clúster fragmentado, o en `false` en caso contrario.	false
AdminDatabase	string	No	Este parámetro solo es obligatorio para instancias de MongoDB. Especifica el nombre de la base de datos de autenticación. El valor predeterminado es `admin`.	admin
UseZstd	string	No	Especifica si se debe utilizar el algoritmo de compresión zstd. Valor predeterminado: `false`.	false
ClusterName	string	No	Este parámetro solo es obligatorio para clústeres fragmentados de MongoDB. Especifica el ID del clúster fragmentado.	dds-0xid8e5336******
IsPhysical	boolean	No	Este parámetro solo es obligatorio cuando descarga datos en formato `qp.xb` desde una instancia de ApsaraDB RDS for MySQL. En este caso, establezca el valor en `true`.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos de la respuesta.
RequestId	string	El ID de la solicitud.	A08F908D-2C35-583F-93C1-ED80753F****
ErrCode	string	El código de error.	DBS.ParamIsInValid
Success	string	Indica si la solicitud se realizó correctamente. Valores válidos: true: la solicitud se realizó correctamente. false: la solicitud falló.	true
ErrMessage	string	El mensaje de error.	formatType can not be empty
Code	string	El código de estado.	DBS.ParamIsInValid
Message	string	El mensaje de error.	formatType can not be empty
Data	object	Los detalles de la tarea de descarga.
BakSetId	string	El ID del conjunto de copias de seguridad completas.	146005****
DownloadStatus	string	El estado de la tarea de descarga. Valores válidos: initializing: la tarea se está inicializando. queueing: la tarea está en cola. running: la tarea se está ejecutando. failed: la tarea falló. finished: la tarea ha finalizado. expired: la tarea ha caducado. Nota Si el destino de descarga es una URL, el enlace caduca tres días después de que la tarea finalice.	initializing
Progress	string	El número de tablas descargadas frente al número total de tablas. Nota Si la tarea se está inicializando, se devuelve `0/0`.	0/0
BackupSetTime	integer	El punto en el tiempo del conjunto de copias de seguridad, devuelto como una marca de tiempo UNIX en milisegundos.	1661373070000
RegionCode	string	El ID de la región.	cn-beijing
TargetPath	string	La ruta de destino para la descarga de datos. Nota Este parámetro se devuelve solo cuando `TargetType` es `OSS`.	test_db/path
DbList	string	Si la descarga corresponde a bases de datos o tablas específicas, este parámetro enumera sus nombres.	testdb
ExportDataSize	integer	El tamaño de los datos exportados, en bytes.	0
ImportDataSize	integer	El tamaño de los datos procesados, en bytes.	0
GmtCreate	integer	La hora de creación de la tarea, devuelta como una marca de tiempo UNIX en milisegundos.	1661940917570
TaskId	string	El ID de la tarea de descarga.	dt-qxnsfq5s****
Format	string	El formato al que se convierten los datos.	CSV
TargetType	string	El tipo de destino para la descarga.	URL

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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