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

Consulta los trabajos de restauración en Database Backup Service (DBS).

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

get

*BackupPlan

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BackupPlanId	string	No	El ID del plan de respaldo. Nota Debe especificar este parámetro o `RestoreTaskId`.	dbs1hvb0wwwXXXXX
RestoreTaskId	string	No	El ID de la tarea de restauración. Puede especificar varios ID separados por comas. Puede llamar a la operación CreateRestoreTask para obtener el ID de la tarea de restauración. Nota Debe especificar este parámetro o `BackupPlanId`. Si especifica ambos parámetros, se devuelve un error.	s102h7rf5anq
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valores válidos: de 1 a 100. Nota El valor predeterminado es 30.	30
PageNum	integer	No	El número de página. El valor debe ser un número entero mayor o igual a 0. Valor predeterminado: 0.	1
ClientToken	string	No	Un token generado por el cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre las diferentes solicitudes.	ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamp	integer	No	El inicio del intervalo de tiempo para consultar las tareas de restauración. Especifique la hora en formato de marca de tiempo UNIX. La marca de tiempo tiene precisión de milisegundos.	1570701361528
EndTimestamp	integer	No	El fin del intervalo de tiempo para consultar las tareas de restauración. Especifique la hora en formato de marca de tiempo UNIX. La marca de tiempo tiene precisión de milisegundos.	1570701361528

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
PageNum	integer	El número de página.	1
RequestId	string	El ID de la solicitud.	9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCode	string	El código de error.	Param.NotFound
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrMessage	string	El mensaje de error.	The specified parameter %s value is not valid
TotalPages	integer	El número total de páginas devueltas.	1
TotalElements	integer	El número total de trabajos de restauración.	1
PageSize	integer	El número de entradas devueltas por página.	30
Items	object
RestoreTaskDetail	array<object>	Los detalles de los trabajos de restauración.
	object
RestoreStatus	string	El estado del trabajo de restauración. Valores válidos: init: El trabajo de restauración se está inicializando o la verificación previa falló. running: El trabajo de restauración se está ejecutando. stop: El trabajo de restauración falló. pause: El trabajo de restauración está en pausa. check_pass: La verificación previa fue exitosa.	running
FullStruAfterRestoreProgress	integer	El progreso de la restauración completa del esquema posterior a la restauración.	100
CrossRoleName	string	El nombre del rol de RAM utilizado para el respaldo entre cuentas.	test123
RestoreDir	string	La ruta de restauración.	/home/test
CrossAliyunId	string	El UID de la cuenta de Alibaba Cloud utilizada para el respaldo entre cuentas.	2xxx7778xxxxxxxxxx
RestoreObjects	string	Los objetos de restauración.	[ { \"DBName\":\"test\" } ]
BackupPlanId	string	El ID del plan de respaldo.	dbsxxxx
DestinationEndpointRegion	string	La región de la instancia de destino.	cn-hangzhou
RestoreTaskCreateTime	integer	La hora en que se creó el trabajo de restauración, representada como una marca de tiempo UNIX en milisegundos.	1554560477000
DestinationEndpointUserName	string	La cuenta de base de datos del endpoint de destino.	testUser
RestoreTaskFinishTime	integer	La hora en que se completó el trabajo de restauración, representada como una marca de tiempo UNIX en milisegundos.	1554560477000
DestinationEndpointIpPort	string	La dirección de conexión de la instancia de base de datos de destino.	100.X.X.10:33204
DestinationEndpointDatabaseName	string	El nombre de la base de datos del endpoint de destino.	test
DestinationEndpointInstanceType	string	El tipo de instancia de destino. Valores válidos: RDS ECS Express: Una base de datos conectada mediante Express Connect, VPN Gateway o Smart Access Gateway. Agent: Una base de datos conectada mediante una puerta de enlace de respaldo. DDS: Una instancia de ApsaraDB for MongoDB. Other: Una base de datos conectada a través de Internet mediante una dirección IP y un puerto. dg: Una base de datos autogestionada sin dirección IP pública, conectada mediante Database Gateway (DG).	RDS
DestinationEndpointOracleSID	string	El SID de Oracle. Nota Este parámetro es obligatorio para bases de datos Oracle.	test
FullStruforeRestoreProgress	integer	El progreso de la restauración completa del esquema previa a la restauración.	100
ErrMessage	string	El mensaje de error.	NULL
RestoreTaskId	string	El ID del trabajo de restauración.	1iyixxxxxx
FullDataRestoreProgress	integer	El progreso de la restauración completa de datos.	100
ContinuousRestoreProgress	integer	El progreso de la restauración incremental de registros.	100
DestinationEndpointInstanceID	string	El ID de la instancia de destino.	rm-bp1p8c2947XXX
BackupSetId	string	El ID del conjunto de respaldo completo utilizado para la restauración.	urjlfmxxxxx
BackupGatewayId	integer	El ID de la puerta de enlace de respaldo.	324234332
RestoreTaskName	string	El nombre del trabajo de restauración.	dbsr1g3xxxx_Restore_Task_1775009514575
RestoreTime	integer	El punto en el tiempo al que se restauran los datos, representado como una marca de tiempo UNIX en milisegundos.	1554560477000
DestinationEndpointHost	string	La dirección IP o el nombre de dominio de la instancia de destino.	127.0.0.1
DestinationEndpointPort	string	El número de puerto de la base de datos de destino.	3306
DestinationEndpointEnableSsl	string	Indica si la conexión a la base de datos de destino está cifrada con SSL.	true
BackupGatewayIdentifier	string	El ID único de la puerta de enlace de respaldo para el endpoint de destino.	TESTGATEWAY
BackupSourceOssRegion	string	La región de OSS del origen del respaldo.	cn-beijing
RestoreDestinationMode	string	El método utilizado para restaurar datos en el endpoint de destino.	EXIST_INSTANCE
PhysicalFullBackupRecoverProgress	integer	El progreso de la restauración física completa. Este parámetro aplica a respaldos físicos de MySQL y SQL Server.	100
PhysicalFullAndIncrementBackupRecoverProgress	integer	El progreso de la restauración física completa e incremental. Este parámetro aplica a respaldos físicos de MySQL.	100
PhysicalIncrementBackupRecoverProgress	integer	El progreso de la restauración física incremental. Este parámetro aplica a respaldos físicos de SQL Server.	100
PhysicalDatabaseOnlineProgress	integer	El progreso de la puesta en línea de la base de datos después de una restauración física. Este parámetro aplica a respaldos físicos de SQL Server.	100
PhysicalBackupRecoverProgress	integer	El progreso de la restauración física. Este parámetro aplica a respaldos físicos de Oracle.	100

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "RestoreTaskDetail": [
      {
        "RestoreStatus": "running",
        "FullStruAfterRestoreProgress": 100,
        "CrossRoleName": "test123",
        "RestoreDir": "/home/test",
        "CrossAliyunId": "2xxx7778xxxxxxxxxx",
        "RestoreObjects": "[ { \\\"DBName\\\":\\\"test\\\" } ]",
        "BackupPlanId": "dbsxxxx",
        "DestinationEndpointRegion": "cn-hangzhou",
        "RestoreTaskCreateTime": 1554560477000,
        "DestinationEndpointUserName": "testUser",
        "RestoreTaskFinishTime": 1554560477000,
        "DestinationEndpointIpPort": "100.X.X.10:33204",
        "DestinationEndpointDatabaseName": "test",
        "DestinationEndpointInstanceType": "RDS",
        "DestinationEndpointOracleSID": "test",
        "FullStruforeRestoreProgress": 100,
        "ErrMessage": "NULL",
        "RestoreTaskId": "1iyixxxxxx",
        "FullDataRestoreProgress": 100,
        "ContinuousRestoreProgress": 100,
        "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
        "BackupSetId": "urjlfmxxxxx",
        "BackupGatewayId": 324234332,
        "RestoreTaskName": "dbsr1g3xxxx_Restore_Task_1775009514575",
        "RestoreTime": 1554560477000,
        "DestinationEndpointHost": "127.0.0.1",
        "DestinationEndpointPort": "3306",
        "DestinationEndpointEnableSsl": "true",
        "BackupGatewayIdentifier": "TESTGATEWAY",
        "BackupSourceOssRegion": "cn-beijing",
        "RestoreDestinationMode": "EXIST_INSTANCE",
        "PhysicalFullBackupRecoverProgress": 100,
        "PhysicalFullAndIncrementBackupRecoverProgress": 100,
        "PhysicalIncrementBackupRecoverProgress": 100,
        "PhysicalDatabaseOnlineProgress": 100,
        "PhysicalBackupRecoverProgress": 100
      }
    ]
  }
}

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.