ModifyBackupPolicy - ApsaraDB for MongoDB - Centro de documentación de Alibaba Cloud

Modifica la política de respaldo de una instancia de MongoDB.

Descripción de la operación

La redundancia geográfica solo está disponible para instancias de conjunto de réplicas e instancias de clúster fragmentado que utilizan discos en la nube.

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

dds:ModifyBackupPolicy

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
DBInstanceId	string	Sí	El ID de la instancia.	dds-bp16cb162771****
PreferredBackupTime	string	No	El intervalo de tiempo para realizar un respaldo. Especifique la hora en formato HH:mmZ-HH:mmZ. La hora se muestra en Tiempo Universal Coordinado (UTC). Nota El intervalo de tiempo debe ser de 1 hora.	03:00Z-04:00Z
PreferredBackupPeriod	string	No	El ciclo de respaldo. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Importante Para garantizar la seguridad de los datos, realice respaldos de la instancia de MongoDB al menos dos veces por semana. Nota Para especificar varios ciclos de respaldo, sepárelos con comas (,).	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	integer	No	El número de días para conservar los respaldos completos. Nota Para las instancias creadas antes del 10 de septiembre de 2021, el período de retención predeterminado es de 7 días. Para las instancias creadas después del 10 de septiembre de 2021, el período de retención predeterminado es de 30 días.	30
EnableBackupLog	integer	No	Especifica si se debe habilitar el respaldo de registros. Valores válidos: 0: Deshabilita el respaldo de registros. Este es el valor predeterminado. 1: Habilita el respaldo de registros. Importante No puede deshabilitar el respaldo de registros para instancias de clúster fragmentado.	0
LogBackupRetentionPeriod	integer	No	El número de días para conservar los respaldos de registros. Valor predeterminado: 7. Valores válidos: de 7 a 730.	7
SnapshotBackupType	string	No	El tipo de respaldo de instantánea. Valores válidos: Flash: respaldo a nivel de segundo. Standard: respaldo convencional. Este es el valor predeterminado.	Standard
BackupInterval	string	No	La frecuencia de los respaldos de alta frecuencia. Valores válidos: -1: El respaldo de alta frecuencia está deshabilitado. 30: cada 30 minutos. 60: cada 1 hora. 120: cada 2 horas. 180: cada 3 horas. 240: cada 4 horas. 360: cada 6 horas. 480: cada 8 horas. 720: cada 12 horas. Nota Si establece SnapshotBackupType en Standard, el valor de este parámetro es -1. El respaldo de alta frecuencia solo surte efecto si establece SnapshotBackupType en Flash y configura este parámetro con un valor mayor que 0.	-1
HighFrequencyBackupRetention	integer	No	El número de días para conservar los respaldos de alta frecuencia. Antes de especificar este parámetro, debe configurar el parámetro BackupInterval. El período de retención predeterminado es de 1 día.	1
BackupRetentionPolicyOnClusterDeletion	integer	No	La política para conservar respaldos cuando libera la instancia. 0: Todos los conjuntos de respaldo de la instancia se eliminan cuando se libera la instancia. 1: Se realiza un respaldo automático cuando se libera la instancia, y este respaldo se conserva durante mucho tiempo. 2: Se realiza un respaldo automático cuando se libera la instancia, y todos los conjuntos de respaldo de la instancia se conservan durante mucho tiempo. Para obtener más información, consulte Retención de respaldos a largo plazo.	2
CrossBackupType	string	No	La política para respaldos con redundancia geográfica. Valores válidos: update: Modifica la política de redundancia geográfica. delete: Elimina la política de redundancia geográfica. Nota Este parámetro es obligatorio si habilita la redundancia geográfica.	update
SrcRegion	string	No	El ID de región de la instancia. Nota Este parámetro es obligatorio si restaura una instancia eliminada. Este parámetro es obligatorio si habilita la redundancia geográfica.	cn-beijing
DestRegion	string	No	El ID de región del respaldo con redundancia geográfica. Nota Este parámetro es obligatorio si habilita la redundancia geográfica.	cn-hangzhou
CrossRetentionType	string	No	La política de retención para respaldos con redundancia geográfica. Valores válidos: delay: Conserva el respaldo durante un período especificado. never: Conserva el respaldo permanentemente. Nota Este parámetro es obligatorio si habilita la redundancia geográfica.	delay
CrossRetentionValue	integer	No	El número de días para conservar los respaldos con redundancia geográfica. Valores válidos: de 3 a 1825. Nota Este parámetro es obligatorio si habilita la redundancia geográfica. Este parámetro es obligatorio si establece CrossRetentionType en delay.	7
CrossBackupPeriod	string	No	Los días de la semana para realizar respaldos con redundancia geográfica. Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Este parámetro es obligatorio si habilita la redundancia geográfica. Para especificar varios días, sepárelos con comas (,). Si establece el método de respaldo en respaldo convencional, los días de la semana especificados por este parámetro deben ser un subconjunto de los días de la semana especificados por PreferredBackupPeriod.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
EnableCrossLogBackup	integer	No	Especifica si se debe habilitar el respaldo de registros entre regiones. Valores válidos: Nota Este parámetro es obligatorio si habilita la redundancia geográfica. 1: Habilita el respaldo de registros entre regiones. Este valor es obligatorio para instancias de clúster fragmentado. También es obligatorio para instancias de conjunto de réplicas si desea habilitar la recuperación a un momento específico con redundancia geográfica. 0: Deshabilita el respaldo de registros entre regiones.	1
CrossLogRetentionType	string	No	La política de retención para respaldos de registros entre regiones. Valores válidos: delay: Conserva el respaldo durante un período especificado. never: Conserva el respaldo permanentemente. Nota Este parámetro es obligatorio si habilita la redundancia geográfica.	delay
CrossLogRetentionValue	integer	No	El número de días para conservar los respaldos de registros entre regiones. Valores válidos: de 3 a 1825. El valor debe ser menor o igual al valor de CrossRetentionValue. Nota Este parámetro es obligatorio si habilita la redundancia geográfica.	3
InstanceType	string	No	El tipo de instancia. Valores válidos: replicate sharding Nota Este parámetro es obligatorio cuando restaura una instancia eliminada. Este parámetro es obligatorio cuando clona una instancia desde un respaldo con redundancia geográfica.	replicate
PreserveOneEachHour	boolean	No	Especifica si se debe habilitar el respaldo disperso por hora. Valores válidos: true: Si la frecuencia de respaldo es en minutos, se conservan todas las instantáneas generadas dentro de la última hora. Para las instantáneas que se generaron hace más de 1 hora pero menos de 24 horas, solo se conserva la primera instantánea generada después de cada hora completa. false: Todas las instantáneas se conservan dentro del período de retención de respaldo de alta frecuencia.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	644A359C-B871-4DD3-97B5-ED91EF5809C2

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

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.