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

Configura un plan de respaldo 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:ConfigureBackupPlan

update

*BackupPlan

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
BackupPlanId	string	Sí	El ID del plan de respaldo. Puede llamar a DescribeBackupPlanList para consultar el ID del plan de respaldo.	dbstooi0*******
SourceEndpointInstanceType	string	Sí	La ubicación de la base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Valores válidos: RDS ECS Express: Una base de datos conectada mediante una línea dedicada, VPN Gateway o Smart Gateway. Agent: Una base de datos conectada mediante una puerta de enlace de respaldo. DDS: Cloud MongoDB. Other: Una base de datos conectada directamente mediante IP:Puerto.	RDS
SourceEndpointRegion	string	No	La región de la base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando SourceEndpointInstanceType es RDS, ECS, DDS, Express o Agent.	cn-hangzhou
SourceEndpointInstanceID	string	No	El ID de la instancia de base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando SourceEndpoint.InstanceType es RDS, ECS, DDS o Express.	rm-uf6wjk5*********
SourceEndpointIP	string	No	El endpoint de la base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando SourceEndpointInstanceType es express, agent u other.	rm-uf6wjk5*******.mysql.rds.aliyuncs.com
SourceEndpointPort	integer	No	El puerto de la base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando SourceEndpoint.InstanceType es express, agent, other o ECS.	3306
SourceEndpointDatabaseName	string	No	El nombre de la base de datos. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando 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 cuando el tipo de base de datos es Redis, o cuando la ubicación de la base de datos es agent y el tipo de base de datos es SQL Server. Es obligatorio en otros escenarios.	testRDS
SourceEndpointPassword	string	No	La contraseña. Nota Este parámetro es opcional cuando el tipo de base de datos es Redis, o cuando la ubicación de la base de datos es agent y el tipo de base de datos es SQL Server. Es obligatorio en otros escenarios.	testPassword
BackupGatewayId	integer	No	El ID de la puerta de enlace de respaldo. Puede llamar a DescribeBackupPlanList para consultar este valor. Nota Este parámetro es obligatorio cuando SourceEndpointInstanceType es agent.	23313123312
OSSBucketName	string	No	El nombre del bucket de OSS. Nota El sistema genera automáticamente un nuevo nombre de forma predeterminada.	TestOssBucket
BackupObjects	string	No	Los objetos de respaldo. Puede llamar a DescribeBackupPlanList para consultar este valor.	[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]
BackupPeriod	string	No	El período de respaldo completo. Valores válidos: Monday: Lunes Tuesday: Martes Wednesday: Miércoles Thursday: Jueves Friday: Viernes Saturday: Sábado Sunday: Domingo	Monday
BackupStartTime	string	No	La hora de inicio del respaldo completo en formato HH:mmZ (UTC). Puede llamar a DescribeBackupPlanList para consultar este valor.	14:22
EnableBackupLog	boolean	No	Habilita el respaldo incremental de registros. Valores válidos: true: Habilitar false: Deshabilitar	true
BackupLogIntervalSeconds	integer	No	El intervalo incremental en segundos (s). Nota Solo se admite el respaldo físico.	1000
BackupRetentionPeriod	integer	No	El período de retención de los datos de respaldo. Valores válidos: de 0 a 1825. Valor predeterminado: 730 días.	730
DuplicationInfrequentAccessPeriod	integer	No	El período después del cual los datos se convierten a almacenamiento de acceso poco frecuente. Valor predeterminado: 180 días.	180
DuplicationArchivePeriod	integer	No	El período después del cual los datos se convierten a almacenamiento frío de archivo. Valor predeterminado: 365 días.	365
BackupPlanName	string	Sí	El nombre personalizado del plan de respaldo. Puede llamar a DescribeBackupPlanList para consultar este valor.	dbstooi0*******
SourceEndpointOracleSID	string	No	El nombre del SID de Oracle. Nota Este parámetro es obligatorio cuando 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 OSS. system: Los datos de respaldo se almacenan en el OSS integrado de DBS.	无
BackupSpeedLimit	integer	No	El límite de E/S de disco en KB/s. Nota Este parámetro solo es válido para el respaldo físico de MySQL.	262144
BackupRateLimit	integer	No	La limitación del ancho de banda de red en KB/s. El valor máximo es 10 GB. Nota Este parámetro solo es válido para el respaldo físico de MySQL.	262144
BackupStrategyType	string	No	El período de respaldo completo. Valores válidos: simple: Respaldo periódico. Utilice este valor con BackupPeriod y BackupStartTime. manual: Respaldo manual. Nota Valor predeterminado: simple.	simple
CrossAliyunId	string	No	El UID para el respaldo entre cuentas de Alibaba Cloud. Puede llamar a DescribeRestoreTaskList para consultar este valor.	2xxx7778xxxxxxxxxx
CrossRoleName	string	No	El nombre del rol de RAM para el respaldo entre cuentas de Alibaba Cloud. Puede llamar a DescribeRestoreTaskList para consultar este valor.	test123
AutoStartBackup	boolean	No	Habilita el respaldo automático. Valores válidos: true: Habilitar false: Deshabilitar	false
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. El cliente genera este valor, que debe ser único entre diferentes solicitudes. El token puede tener hasta 64 caracteres ASCII de longitud.	ETnLKlblzczshOTUbOCzxxxxxxx
ResourceGroupId	string	No	El ID del grupo de recursos.	rg-aekzecovzti****
EnableSourceEndpointSsl	string	No		true
BackupStorageEncryptMethod	string	No		encrypted
SslCaPem	string	No		-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
SourceEndpointOracleHome	string	No		/home/test
EnableMysqlPhysicalBackupBinlog	string	No		true

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.	F1FB49D4-B504-47F1-9F43-D7EAB33F****
ErrCode	string	El código de error.	Param.NotFound
Success	boolean	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.	The specified parameter %s value is not valid
BackupPlanId	string	El ID del plan de respaldo.	dbstooi01ex****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

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.