Todos los productos
Search

Este producto

    ApsaraDB RDS:ImportUserBackupFile

    Centro de documentos

    ApsaraDB RDS:ImportUserBackupFile

    Última actualización: Sep 02, 2026

    Esta API se utiliza para importar datos de respaldo desde una base de datos MySQL 5.7 autogestionada a RDS.

    Descripción de la operación

    Motor compatible

    • RDS MySQL

    Descripción de la función

    Los respaldos de usuario son datos de respaldo completo provenientes de una base de datos MySQL autogestionada. Puede recuperar los respaldos de usuario en la nube.

    Notas

    Para invocar esta API, debe cumplir las siguientes condiciones:

    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

    rds:ImportUserBackupFile

    create

    *DBInstance

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

    		 Ninguna Ninguna

    Parámetros de la solicitud

    Parámetro

    Tipo

    Obligatorio

    Descripción

    Ejemplo
    RegionId

    string

    Sí

    El ID de la región de la instancia. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.

    Nota

    • El valor de este parámetro es el ID de la región en la que desea crear la instancia.

    • El valor de este parámetro debe coincidir con el valor de BucketRegion.

    cn-hangzhou
    Mode

    string

    No

    Modo de importación. Valores válidos:

    • oss: descarga el respaldo desde OSS y lo importa.

    • stream: importa el respaldo a través de la red.

    oss
    EngineVersion

    string

    No

    La versión del motor de base de datos que se ejecuta en la base de datos MySQL autogestionada y en la instancia de ApsaraDB RDS for MySQL. Establezca el valor en 5.7.

    5.7
    BucketRegion

    string

    No

    El ID de la región del bucket de OSS donde se encuentra el archivo de respaldo completo de la base de datos MySQL autogestionada. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.

    cn-hangzhou
    BackupFile

    string

    No

    Una matriz JSON que contiene la información sobre el archivo de respaldo completo almacenado como objeto en un bucket de OSS. Ejemplo: {"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}

    La matriz JSON contiene los siguientes campos:

    • Bucket: el nombre del bucket de OSS en el que se almacena el archivo de respaldo completo como objeto. Puede llamar a la operación GetBucket para consultar el nombre del bucket.

    • Object: la ruta del archivo de respaldo completo que se almacena como objeto en el bucket de OSS. Puede llamar a la operación GetObject para consultar la ruta del objeto.

    • Location: el ID de la región en la que se encuentra el bucket de OSS. Puede llamar a la operación GetBucketLocation para consultar la región del bucket.

    {"Bucket":"test", "Object":"test/test_db_employees.xb","Location":"ap-southeast-1"}
    Comment

    string

    No

    La descripción del archivo de respaldo completo.

    BackupTest
    RestoreSize

    integer

    No

    La cantidad de almacenamiento necesaria para restaurar los datos del archivo de respaldo completo. Unidad: GB.

    Nota

    • El valor predeterminado de este parámetro es 5 veces el tamaño del archivo de respaldo completo.

    • El valor mínimo de este parámetro es 20.

    20
    Retention

    integer

    No

    El periodo de retención del archivo de respaldo completo. Unidad: días. Valores válidos: cualquier entero positivo distinto de cero.

    30
    ZoneId

    string

    No

    El ID de la zona. Puede llamar a la operación DescribeRegions para consultar el ID de la zona.

    Nota

    • Si especifica este parámetro, el sistema crea una instantánea en segundos de un solo dígito, lo que reduce significativamente el tiempo necesario para importar el archivo de respaldo completo.

    • Cuando llama a la operación CreateDBInstance para crear una instancia utilizando el archivo de respaldo completo, la instancia se crea en la zona que especifique para este parámetro.

    cn-hangzhou-b
    ResourceGroupId

    string

    No

    El ID del grupo de recursos. Puede llamar a la operación DescribeDBInstanceAttribute para consultar el ID del grupo de recursos.

    rg-acfmy****
    DBInstanceId

    string

    No

    El ID de la instancia.

    rm-uf6wjk5****
    SourceInfo

    string

    No

    Una matriz JSON que distingue entre mayúsculas y minúsculas y proporciona la información de origen para un respaldo completo. Ejemplo:

    {"sourceIp":"172.20.xx.xx","sourcePort":"9999"}

    Los parámetros de la matriz se describen a continuación:

    • sourceIp: dirección IP de origen.

    • sourcePort: puerto en el que Netcat escucha en el origen.

    Nota

    Esto aplica únicamente a instancias de replicación nativa y requiere que se pase el parámetro DBInstanceId al invocar la API.

    {"sourceIp":"172.20.xx.xx","sourcePort":"9999"}
    BuildReplication

    boolean

    No

    Especifica si se debe configurar automáticamente la replicación. Valores válidos:

    • true: Sí. Se requiere el parámetro MasterInfo.

    • false: No.

    Nota

    Esto aplica únicamente a instancias de replicación nativa y requiere que se pase el parámetro DBInstanceId al invocar la API.

    true
    MasterInfo

    string

    No

    Una matriz JSON que distingue entre mayúsculas y minúsculas y contiene la información del maestro para configurar la replicación de MySQL. Ejemplo:

    {"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}

    Los parámetros de la matriz se describen a continuación:

    • masterIp: dirección IP de la base de datos principal.

    • masterPort: puerto de la base de datos principal.

    • masterUser: cuenta de replicación para la base de datos principal.

    • masterPassword: contraseña de la cuenta de replicación de la base de datos principal, que debe estar codificada en Base64.

    Nota

    Esto aplica únicamente a instancias de replicación nativa y requiere que se pase el parámetro DBInstanceId al invocar la API.

    {"masterIp":"172.20.xx.xx","masterPort":"3306","masterUser":"replica","masterPassword":"W33uopkehBQ="}

    Elementos de la respuesta

    Elemento

    Tipo

    Descripción

    Ejemplo

    object

    Los parámetros de respuesta.

    BackupId

    string

    El ID del archivo de respaldo completo.

    b-n8tpg24c6i0v****
    RequestId

    string

    El ID de la solicitud.

    A140DD14-DCC9-4548-9C72-52A49A58A310
    Status

    boolean

    Indica si el archivo de respaldo completo se importó correctamente a la instancia. Si el archivo de respaldo completo se importa correctamente, se devuelve true. De lo contrario, se devuelve un mensaje de error.

    true

    Ejemplos

    Respuesta exitosa

    JSON Formato

    {
  "BackupId": "b-n8tpg24c6i0v****",
  "RequestId": "A140DD14-DCC9-4548-9C72-52A49A58A310",
  "Status": true
}

    Códigos de error

    Código de estado HTTP

    Código de error

    Mensaje de error

    Descripción
    400 InvalidOssBackupFile.InvalidFile The specified OSS backup file is invalid. The operation failed. The backup file cannot be found in the OSS bucket.
    400 OperationDenied.Product The product code is not supported.
    400 InvalidBackupFile.Format The specified params BackupFile(BackupId or RestoreTime or BackupFile) is not valid. The specified parameter BackupFile(BackupId, RestoreTime, or BackupFile) is invalid.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. Pricing plan price result not found.
    400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. Your account available limit is less than 0, please recharge before trying to purchase.
    400 CommodityServiceCalling.Exception Failed to call commodity service. Failed to call commodity service return.
    400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. The module you purchased is not legal, please buy it again.
    400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. Hello customer, this area has been abolished.
    400 Price.CommoditySys Commodity system call exception. Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance. Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. There is a problem with the period you selected, please choose again.
    400 pay.noCreditCard Account not bound to credit card.
    400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. No payment method has been specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is not complete, please complete your basic information before operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported. The current interface does not support.
    400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The DBInstanceId provided does not exist.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support the specified storage type.
    400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400 KmsApiError User secret key invalid. The user key is invalid.
    400 System.SaleValidateFailed Sales expression validation system error. A system error occurs when the sales expression is verified.
    400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. SQL command execution failed or timed out
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation. This operation is not supported by the instance type.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. The link address name is duplicate. Please reset the connection string.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters. Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400 InvalideStatus.Format The instance status does not support this operation.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. This operation is not supported for the database engine of the instance.
    400 Pay.NoCreditCard No credit cards. No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. The vpc network type instance does not support this operation.
    400 MirrorInsExists Specified DB instance mirror ins already existed. Specified DB instance mirror ins already existed.
    400 UnsupportedClassCode The specified DB instance class stops selling. The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set. The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product. Failed to query product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order. The instance has been released, please verify and place an order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported. The region is no longer supported.
    400 InvalidUserBakset The user backup set to be imported is invalid. Imported user backup is invalid
    500 ExternalFailure The request processing has failed due to external service failure. The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. The service request failed. Please try again later or contact service personnel.
    500 InvokeProxyFailure The request processing has failed due to service failure of rds api. The request failed to be processed due to an RDS API failure.
    403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Please pay first and try again.
    403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. The scale-in target capacity cannot be less than the current storage space usage
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation. The user is not authorized to perform this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 IncorrectMinorVersion Current engine minor version does not support operations. This operation is not supported for the current minor engine version.
    403 OperationDenied.ZoneResource There is no available zone for inventory. There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission. Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. The specified database instance type does not support this operation.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The instance does not have permissions to access Key Management Service (KMS).
    404 Request.NotFound The requested resource is not available. The requested resources are unavailable.
    404 HostInfo.NotFound The specified host info is not found.

    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.