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

Crea una tarea de restauración de Database Backup (DBS).

Descripción de la operación

Operaciones relacionadas

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

create

*Todos los recursos.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BackupPlanId	string	Sí	El ID del plan de respaldo.	dbs1hvb0ww****
DestinationEndpointInstanceType	string	Sí	La ubicación de la base de datos. Valores válidos: RDS ECS Express: bases de datos conectadas a través de circuitos de Express Connect, puertas de enlace VPN o Smart Access Gateway (SAG) Agent: bases de datos conectadas a través de puertas de enlace de respaldo DDS: ApsaraDB for MongoDB Other: bases de datos conectadas mediante direcciones IP y números de puerto dg: bases de datos autogestionadas que no tienen direcciones IP públicas ni números de puerto y están conectadas a través de Database Gateway	RDS
DestinationEndpointRegion	string	No	La región de la instancia de base de datos. Nota Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en RDS, ECS, DDS, Express o Agent.	cn-hangzhou
DestinationEndpointInstanceID	string	No	El ID de instancia de la base de datos. Nota Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en RDS, ECS, DDS o Express.	rm-bp1p8c29*****
DestinationEndpointIP	string	No	La dirección de conexión de la base de datos. Nota Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en Express, Agent u Other.	rm-bp*****9jv8pxero.mysql.rds.aliyuncs.com
DestinationEndpointPort	integer	No	El número de puerto de la base de datos. Nota Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en Express, Agent, Other o ECS.	3306
DestinationEndpointDatabaseName	string	No	El nombre de la base de datos. Nota Este parámetro es obligatorio si el motor de base de datos es PostgreSQL o MongoDB.	test
DestinationEndpointUserName	string	No	El nombre de usuario de la cuenta de la base de datos. Nota Este parámetro no es obligatorio si el motor de base de datos es Redis, o si la base de datos está conectada a través de una puerta de enlace de respaldo y el motor de base de datos es SQL Server. En otros escenarios, este parámetro es obligatorio.	test
DestinationEndpointPassword	string	No	La contraseña de la cuenta de la base de datos. Nota Este parámetro no es obligatorio si el motor de base de datos es Redis, o si la base de datos está conectada a través de una puerta de enlace de respaldo y el motor de base de datos es SQL Server. En otros escenarios, este parámetro es obligatorio.	Test
BackupGatewayId	integer	No	El ID de la puerta de enlace de respaldo. Nota Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en Agent.	4312****
RestoreObjects	string	No	Los objetos que se van a restaurar. Para obtener más información, consulte la definición del parámetro RestoreObjects a continuación. Este parámetro no es obligatorio si la base de datos está conectada a través de una puerta de enlace de respaldo. En otros escenarios, este parámetro es obligatorio. Plantilla: `[{ "DBName": "Nombre de la base de datos que se va a restaurar", "NewDBName": "Nombre de la base de datos de destino" }]` Nota La restauración de objetos mediante esta operación de API solo admite la restauración a nivel de base de datos. Para restaurar tablas específicas, vaya a la consola. Para obtener más información, consulte Restaurar una base de datos.	Example of MySQL table-level restoration: [{\"DBName\":\"dbname\", \"NewDBName\":\"dbname1\"}]
RestoreTime	integer	No	El punto en el tiempo al que desea restaurar la base de datos. El valor es una marca de tiempo UNIX en milisegundos.	1554560477000
BackupSetId	string	No	El ID del conjunto de respaldo completo utilizado para la restauración. Este parámetro y RestoreTime son mutuamente excluyentes.	dbs1hvb0w*****
RestoreTaskName	string	Sí	El nombre de la tarea de restauración.	test
DestinationEndpointOracleSID	string	No	El SID de Oracle. Nota Este parámetro es obligatorio si el motor de base de datos es Oracle.	test
RestoreDir	string	No	Este parámetro es obligatorio si DestinationEndpointInstanceType se establece en Agent y el plan de respaldo es para MySQL.	test
RestoreHome	string	No	El directorio del programa de base de datos.	test
DuplicateConflict	string	No	El método utilizado para manejar los conflictos entre objetos con el mismo nombre. Valores válidos: renamenew: cambia el nombre del objeto si ya existe un objeto con el mismo nombre.	renamenew
CrossAliyunId	string	No	El UID de la cuenta de Alibaba Cloud utilizado para el respaldo entre cuentas.	2749528728********
CrossRoleName	string	No	El nombre del rol de RAM utilizado para el respaldo entre cuentas.	test123
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud y evitar envíos duplicados.	ETnLKlblzczshOTUbOC********
RestoreDestinationMode	string	No	El método utilizado para restaurar datos en el destino. Valores válidos: EXIST_INSTANCE: restaura datos en una instancia existente. NEW_INSTANCE: restaura datos en una nueva instancia.	EXIST_INSTANCE
EnableDestinationEndpointSsl	boolean	No	Especifica si se debe conectar al destino mediante una conexión cifrada con SSL.	true
SslCaPem	string	No	La credencial para la conexión cifrada con SSL al destino.	-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
DestDatabaseInstanceType	string	No	El tipo de instancia de la nueva base de datos en la que se restauran los datos.	rds
DestDatabaseInstanceRegion	string	No	La región de la nueva instancia de base de datos en la que se restauran los datos.	cn-beijing
DestDatabaseInstanceVpc	string	No	La VPC de la nueva instancia de base de datos en la que se restauran los datos.	vpc-xx
DestDatabaseInstanceClass	string	No	Las especificaciones de instancia de la nueva instancia de base de datos en la que se restauran los datos.	mysql.x4.large.2
DestDatabaseInstanceStorageSize	string	No	El tamaño de almacenamiento de instancia de la nueva base de datos que se va a recuperar.	500
DestDatabaseInstanceVSwitch	string	No	El vSwitch de la nueva instancia de base de datos en la que se restauran los datos.	vsw-xx
DestDatabaseInstanceDatabaseVersion	string	No	La versión del motor de base de datos de la nueva instancia de base de datos en la que se restauran los datos.	8.0
AutoOpenDatabase	string	No	Especifica si se debe iniciar automáticamente la instancia después de restaurar un respaldo físico de Oracle.	true
AutoShutdownDatabase	string	No	Especifica si se debe apagar automáticamente la instancia después de restaurar un respaldo físico de Oracle.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los detalles de los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC
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.
RestoreTaskId	string	El ID de la tarea de restauración.	s102h*****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "60AF7C5D-EF4D-4D48-8FD5-C0823FDF28AC",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid",
  "RestoreTaskId": "s102h*****"
}

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.