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

Consulta una lista de tareas de descarga avanzada para instancias de RDS for MySQL, RDS for PostgreSQL y PolarDB for MySQL.

Descripción de la operación

Motores compatibles

Instancias de ApsaraDB RDS for MySQL que utilizan discos en la nube
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL
MongoDB

Documentos relacionados

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

get

*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 reside la instancia. Para obtener el ID de la región, llame a DescribeDBInstanceAttribute.	cn-hangzhou
InstanceName	string	No	El ID de la instancia. Nota Este parámetro es obligatorio.	rm-bp1imnmcjxdz7****
DatasourceId	string	No	El ID del origen de datos en DBS. El formato es: ds-${ID de instancia}_${ID de región}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	No	El ID del conjunto de copias de seguridad. Para obtener el ID del conjunto de copias de seguridad, llame a DescribeBackups.	216****
State	string	No	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 se completó correctamente. expired: La descarga ha caducado.	queueing
TaskType	string	No	El tipo de tarea de descarga. Valores válidos: full: descarga de conjunto de copias de seguridad completas. pitr: descarga de recuperación a un punto en el tiempo.	full
StartTime	string	No	El inicio del intervalo de tiempo para consultar tareas según su hora de creación. Es una marca de tiempo UNIX en milisegundos (ms).	1661941554000
EndTime	string	No	El fin del intervalo de tiempo para consultar tareas según su hora de creación. Es una marca de tiempo UNIX en milisegundos (ms).	1661941556000
PageSize	string	No	El número de entradas que se devolverán en cada página.	50
CurrentPage	string	No	El número de página.	1
OrderDirect	string	No	La dirección de ordenación. Valores válidos: asc: orden ascendente. desc: orden descendente. Este es el valor predeterminado.	desc
OrderColumn	string	No	El campo utilizado para la ordenación. El valor predeterminado es gmt_create, que indica la hora de creación.	gmt_create
ClusterName	string	No	El nombre del clúster fragmentado. Este parámetro solo es obligatorio para instancias de MongoDB.	dds-example

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros devueltos.
RequestId	string	El ID de la solicitud.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	El código de error.	DBS.InternalError
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.	instanceName can not be empty
Code	string	El código de error.	DBS.InternalError
Message	string	El mensaje de error.	instanceName can not be empty
Data	object	Los detalles de la tarea.
PageNumber	integer	El número de página. Debe ser mayor que 0 y no exceder el valor máximo del tipo de datos entero. Valor predeterminado: 1.	1
TotalPages	integer	El número total de páginas.	2
Extra	string	Información adicional sobre la tarea que se utiliza para realizar copias de seguridad de datos en la nube.	dbtest
TotalElements	integer	El número total de tareas de descarga.	1
PageSize	integer	El número de entradas devueltas por página.	10
Content	object
List	array<object>	Los detalles de la tarea.
	object	Los detalles de la tarea.
TaskId	string	El ID de la tarea de descarga.	dt-qxntlvgu****
RegionCode	string	El ID de la región.	cn-hangzhou
Format	string	El formato de destino al que se convierten los datos descargados. Valores válidos: csv SQL Parquet	csv
DbList	string	La lista de bases de datos.	[dbtest]
BakSetId	string	El ID del conjunto de copias de seguridad completas.	148261****
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 se completó correctamente. expired: La descarga ha caducado.	queueing
ExportDataSize	string	El volumen de datos exportados, en bytes.	0
ImportDataSize	string	El volumen de datos procesados, en bytes.	0
BackupSetTime	string	El punto en el tiempo de la tarea de descarga de recuperación a un punto en el tiempo. Es una marca de tiempo UNIX en milisegundos (ms).	1663162216000
TargetType	string	El tipo de destino de la descarga. Valores válidos: OSS URL	URL
TargetPath	string	La ruta de destino de los datos descargados. Este parámetro se devuelve cuando TargetType se establece en OSS.	test_db/path
Progress	string	El número de tablas exportadas/El número total de tablas por exportar.	0/0
GmtCreate	string	La hora en que se creó la tarea. Es una marca de tiempo UNIX en milisegundos.	1663321957000

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
403	Request.Forbidden	Have no Permissions

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.