Modifier les paramètres de sauvegarde interrégionale d'une instance ApsaraDB RDS -

Avant d'appeler cette opération, assurez-vous que l'instance source exécute l'un des moteurs de base de données suivants :

MySQL. Pour plus d'informations, consultez la rubrique Activer les sauvegardes interrégionales pour une instance ApsaraDB RDS for MySQL.
SQL Server. Pour plus d'informations, consultez la rubrique Activer les sauvegardes interrégionales pour une instance ApsaraDB RDS for SQL Server.
PostgreSQL. Pour plus d'informations, consultez la rubrique Activer les sauvegardes interrégionales pour une instance ApsaraDB RDS for PostgreSQL.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyInstanceCrossBackupPolicy	Opération à effectuer. Définissez la valeur sur ModifyInstanceCrossBackupPolicy.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxxxxx	ID de l'instance.
RegionId	String	Yes	cn-hangzhou	ID de la région de l'instance source. Appelez l'opération DescribeRegions pour obtenir la liste des régions.
CrossBackupType	String	No	1	Politique d'enregistrement des fichiers de sauvegarde interrégionale de l'instance. Définissez la valeur sur 1. La valeur 1 indique que tous les fichiers de sauvegarde interrégionale sont enregistrés.
LogBackupEnabled	String	No	1	Statut de la fonctionnalité de sauvegarde des journaux interrégionaux sur l'instance. Valeurs possibles : 0 : désactive la fonctionnalité. 1 : active la fonctionnalité. Remarque Vous ne pouvez activer la sauvegarde des journaux interrégionaux que si la sauvegarde interrégionale est activée.
BackupEnabled	String	No	1	Statut de la fonctionnalité de sauvegarde interrégionale sur l'instance. Ce paramètre détermine si les données et les journaux sont sauvegardés. Valeurs possibles : 0 : désactive la fonctionnalité. 1 : active la fonctionnalité. Remarque Avant d'activer la sauvegarde interrégionale, configurez le paramètre CrossBackupRegion.
CrossBackupRegion	String	No	cn-shanghai	ID de la région de destination où sont stockés les fichiers de sauvegarde interrégionale de l'instance.
RetentType	Integer	No	1	Politique de conservation des fichiers de sauvegarde interrégionale de l'instance. Définissez la valeur sur 1. La valeur 1 indique que les fichiers sont conservés selon la période de rétention spécifiée.
Retention	Integer	No	7	Durée de conservation (en jours) des fichiers de sauvegarde interrégionale de l'instance. Valeurs possibles : 7 à 1825.

Paramètres de réponse

Parameter	Type	Example	Description
BackupEnabled	String	Enable	Statut de la fonctionnalité de sauvegarde interrégionale sur l'instance. Valeurs possibles : Disable Enable
RegionId	String	cn-hangzhou	ID de la région de l'instance source. Appelez l'opération DescribeRegions pour obtenir la liste des régions.
LogBackupEnabled	String	Enable	Statut de la fonctionnalité de sauvegarde des journaux interrégionaux sur l'instance. Valeurs possibles : Disable Enable
RequestId	String	50A6059D-6DBB-46C6-A851-1EE93C9013CF	ID de la requête.
RetentType	Integer	1	Politique de conservation des fichiers de sauvegarde interrégionale de l'instance. Valeur par défaut : 1. La valeur 1 indique que les fichiers sont conservés selon la période de rétention spécifiée.
CrossBackupRegion	String	cn-shanghai	ID de la région de destination où sont stockés les fichiers de sauvegarde interrégionale de l'instance.
CrossBackupType	String	1	Politique d'enregistrement des fichiers de sauvegarde interrégionale de l'instance. Valeur par défaut : 1. La valeur 1 indique que tous les fichiers de sauvegarde interrégionale sont enregistrés.
Retention	Integer	15	Durée de conservation (en jours) des fichiers de sauvegarde interrégionale de l'instance. Valeurs possibles : 7 à 1825.
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID de l'instance.

Exemples

Exemple de requête

http(s)://rds.aliyuncs.com/?Action=ModifyInstanceCrossBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyInstanceCrossBackupPolicyResponse>
<CrossBackupType>1</CrossBackupType>
    <LogBackupEnabled>Enable</LogBackupEnabled>
    <BackupEnabled>Enable</BackupEnabled>
    <CrossBackupRegion>cn-shanghai</CrossBackupRegion>
    <RetentType>1</RetentType>
    <RequestId>50A6059D-6DBB-46C6-A851-1EE93C9013CF</RequestId>
    <DBInstanceId>rm-bpxxxxx</DBInstanceId>
    <RegionId>cn-hangzhou</RegionId>
    <StorageType>oss</StorageType>
    <Endpoint></Endpoint>
    <Retention>15</Retention>
</ModifyInstanceCrossBackupPolicyResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CrossBackupType" : "1",
  "LogBackupEnabled" : "Enable",
  "BackupEnabled" : "Enable",
  "CrossBackupRegion" : "cn-shanghai",
  "RetentType" : 1,
  "RequestId" : "50A6059D-6DBB-46C6-A851-1EE93C9013CF",
  "DBInstanceId" : "rm-bpxxxxx",
  "RegionId" : "cn-hangzhou",
  "StorageType" : "oss",
  "Endpoint" : "",
  "Retention" : 15
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	ParameterLeastAssociate	Must input at least one optional parameter.	Le message d'erreur renvoyé indique que les paramètres restoreTime et BackupId de l'instance ne peuvent pas être vides simultanément. Vous devez configurer au moins l'un des paramètres et réessayer.
400	InvalidRegion.Format	Specified Region is not valid.	Le message d'erreur renvoyé indique que la région spécifiée n'est pas valide.
400	OperationDenied.SwitchToCrossRegionBackup	Snapshot backup does not support cross region backup storage at present.	Le message d'erreur renvoyé indique que les sauvegardes et le stockage interrégionaux ne sont pas pris en charge pour les sauvegardes instantanées.
400	OperationDenied.SwitchToSnapshot	Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.	Le message d'erreur renvoyé indique que les fichiers de sauvegarde instantanée ne peuvent pas être stockés dans une région différente de celle où réside l'instance. Avant d'activer la fonctionnalité de sauvegarde instantanée, vous devez désactiver la fonctionnalité de sauvegarde interrégionale.
400	OperationDenied.SwitchSnapshotToPhysical	Only physical backup to snapshot backup is supported.	Le message d'erreur renvoyé indique que l'opération prend uniquement en charge le passage de la méthode de sauvegarde physique à la méthode de sauvegarde instantanée.
403	IncorrectEngineVersion	Current engine version does not support operations.	Le message d'erreur renvoyé indique que cette opération n'est pas prise en charge pour la version du moteur de base de données exécutée sur l'instance.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	Le message d'erreur renvoyé indique que cette opération n'est pas prise en charge lorsque l'instance se trouve dans l'état actuel.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	Le message d'erreur renvoyé indique que le moteur de base de données de l'instance ne prend pas en charge cette opération.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.	Le message d'erreur renvoyé indique que l'instance est verrouillée.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	Le message d'erreur renvoyé indique que cette opération n'est pas prise en charge lorsque l'instance se trouve dans l'état actuel.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	Le message d'erreur renvoyé indique que l'instance est introuvable, a été supprimée ou ne prend pas en charge l'opération.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.