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

Crea, configura e inicia un plan de respaldo.

Descripción de la operación

Antes de llamar a esta operación, asegúrese de comprender los métodos de facturación y precios de Database Backup (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:CreateAndStartBackupPlan

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BackupPlanId	string	No	El ID del plan de respaldo.	dbstooi0*******
Region	string	No	La región donde DBS está disponible. Para ver las regiones disponibles, llame a la operación DescribeRegions.	cn-hangzhou
InstanceClass	string	Sí	La especificación del plan de respaldo. Valores válidos: micro small medium large xlarge Nota Las especificaciones más altas proporcionan un mejor rendimiento de respaldo y recuperación. Para obtener más información, consulte Especificaciones.	micro
DatabaseType	string	Sí	El tipo de base de datos. Valores válidos: MySQL MSSQL Oracle MariaDB PostgreSQL DRDS MongoDB Redis	MySQL
BackupMethod	string	Sí	El método de respaldo. Valores válidos: logical: respaldo lógico physical: respaldo físico	logical
Period	string	No	El ciclo de facturación de la instancia de suscripción. Valores válidos: Year Month	Year
UsedTime	integer	No	La duración de la suscripción. Valores válidos: Si Period se establece en Year, el valor de UsedTime puede ser de 1 a 5. Si Period se establece en Month, el valor de UsedTime puede ser de 1 a 11.	1
PayType	string	No	El método de pago. Valor válido: prepay: suscripción	prepay
DatabaseRegion	string	No	La región donde se encuentra la base de datos.	cn-hangzhou
StorageRegion	string	No	La región de almacenamiento.	cn-hangzhou
InstanceType	string	No	El tipo de instancia de base de datos. Valores válidos: RDS PolarDB DDS: Alibaba Cloud MongoDB Kvstore: Alibaba Cloud Redis Other: una base de datos conectada mediante una dirección IP y un puerto. dg: una base de datos autogestionada sin dirección IP pública ni puerto, conectada a través de Database Gateway (DG).	RDS
StorageType	string	No	Este parámetro aún no está disponible.	无
FromApp	string	No	El origen de la solicitud. El valor predeterminado es OpenApi. No necesita configurar este parámetro.	OpenApi
SourceEndpointInstanceType	string	Sí	La ubicación de la base de datos. Valores válidos: RDS ECS Express: una base de datos conectada a través de una línea arrendada, VPN Gateway o Smart Access Gateway. Agent: una base de datos conectada a través de una puerta de enlace de respaldo. DDS: Alibaba Cloud MongoDB Other: una base de datos conectada directamente mediante una dirección IP y un puerto. dg: una base de datos autogestionada sin dirección IP pública ni puerto, conectada a través de Database Gateway (DG).	RDS
SourceEndpointRegion	string	No	La región donde se encuentra la base de datos. Nota Este parámetro es obligatorio si SourceEndpoint.InstanceType se establece en RDS, ECS, DDS, Express o Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	El ID de la instancia de base de datos. Nota Este parámetro es obligatorio si SourceEndpoint.InstanceType se establece en RDS, ECS, DDS o Express.	rm-uf6wjk5xxxxxxxxxx
SourceEndpointIP	string	No	El endpoint de la base de datos. Nota Este parámetro es obligatorio si SourceEndpoint.InstanceType se establece en express, agent u other.	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	El puerto de la base de datos. Nota Este parámetro es obligatorio si SourceEndpoint.InstanceType se establece en express, agent, other o ECS.	3306
SourceEndpointDatabaseName	string	No	El nombre de la base de datos. Nota Este parámetro es obligatorio si el tipo de base de datos es PostgreSQL o MongoDB.	testRDS
SourceEndpointUserName	string	No	La cuenta de la base de datos. Nota Este parámetro es opcional si el tipo de base de datos es Redis, o si la ubicación de la base de datos es agent y el tipo de base de datos es MSSQL. En todos los demás casos, este parámetro es obligatorio.	testRDS
SourceEndpointPassword	string	No	La contraseña de la cuenta de la base de datos. Nota Este parámetro es opcional si el tipo de base de datos es Redis, o si la ubicación de la base de datos es agent y el tipo de base de datos es MSSQL. En todos los demás casos, este parámetro es obligatorio.	testPassword
BackupGatewayId	integer	No	El ID de la puerta de enlace de respaldo. Nota Este parámetro es obligatorio si SourceEndpoint.InstanceType se establece en agent. Para obtener más información sobre cómo crear una puerta de enlace de respaldo, consulte Agregar una puerta de enlace de respaldo. Puede llamar a la operación DescribeBackupGatewayList para ver la lista de puertas de enlace de respaldo existentes.	23313123312
OSSBucketName	string	No	El nombre del bucket de Object Storage Service (OSS). Valor predeterminado: el sistema genera automáticamente un nuevo nombre.	TestOssBucket
BackupObjects	string	No	Los objetos de respaldo.	[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
BackupPeriod	string	No	El ciclo de respaldo completo. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Puede seleccionar varios valores. Sepárelos con comas (,).	Monday
BackupStartTime	string	No	La hora de inicio del respaldo completo. La hora tiene el formato HH:mm y está en UTC.	14:22
EnableBackupLog	boolean	No	Especifica si se debe habilitar el respaldo incremental de registros. Valores válidos: true false	true
BackupLogIntervalSeconds	integer	No	El intervalo para respaldos incrementales, en segundos. Nota Este parámetro es obligatorio solo para respaldos físicos.	1000
BackupRetentionPeriod	integer	No	El período de retención de los datos de respaldo, en días. Valores válidos: 0 a 1825. Valor predeterminado: 730.	730
DuplicationInfrequentAccessPeriod	integer	No	El tiempo después del cual los datos de respaldo se convierten a almacenamiento de acceso poco frecuente (IA), en días. Valor predeterminado: 180.	180
DuplicationArchivePeriod	integer	No	El tiempo después del cual los datos de respaldo se convierten a almacenamiento de archivo, en días. Valor predeterminado: 365.	365
BackupPlanName	string	Sí	El nombre personalizado del plan de respaldo.	dbstooi0*******
SourceEndpointOracleSID	string	No	El ID de sistema (SID) de Oracle. Este parámetro es obligatorio si el tipo de base de datos es Oracle.	test
BackupStorageType	string	No	El tipo de almacenamiento integrado: Vacío (predeterminado): los datos de respaldo se almacenan en su bucket de OSS. system: los datos de respaldo se almacenan en el bucket de OSS integrado de DBS.	无
BackupSpeedLimit	integer	No	El límite de E/S de disco, en KB/s. Nota Este parámetro es válido solo para respaldos físicos de MySQL.	262144
BackupRateLimit	integer	No	El límite de limitación de ancho de banda de red, en KB/s. El valor máximo permitido es 10 GB. Nota Este parámetro es válido solo para respaldos físicos de MySQL.	262144
BackupStrategyType	string	No	La estrategia de respaldo completo. Valores válidos: simple: respaldo periódico. Utilice este valor con BackupPeriod y BackupStartTime. manual: respaldo manual. Nota El valor predeterminado es simple.	simple
CrossAliyunId	string	No	El UID de la cuenta de Alibaba Cloud para respaldos entre cuentas.	1648821913******
CrossRoleName	string	No	El nombre del rol de RAM para respaldos entre cuentas.	test123
ClientToken	string	No	Un token de cliente utilizado para garantizar la idempotencia de la solicitud. Esto evita solicitudes duplicadas.	ASDASDASDSADASFCZXVZ
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-aekzecovzti****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	4F1888AC-1138-4995-B9FE-D2734F61C058
CreateBackupSet	boolean	Indica si el conjunto de respaldo está habilitado. El valor devuelto es uno de los siguientes: true: habilitado false: deshabilitado	true
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
BackupPlanId	string	El ID del plan de respaldo.	dbs1hvb0wwwe****
OrderId	string	El ID del pedido.	2056157***

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

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.