Todos os produtos
Search
Central de documentação

:Modifique as configurações de backup entre regiões de uma instância ApsaraDB RDS

Última atualização: Jun 26, 2026

Use a operação ModifyInstanceCrossBackupPolicy para modifique as configurações de backup entre regiões de uma instância ApsaraDB RDS.

Antes de usar esta operação, verifique se a instância source executa um dos seguintes mecanismos de banco de dados:

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar o OpenAPI Explorer para chamar esta operação. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

ParâmetroTipoObrigatórioExemploDescrição
ActionStringSimModifyInstanceCrossBackupPolicy

Operação a ser executada. Defina o valor como ModifyInstanceCrossBackupPolicy.

DBInstanceIdStringSimrm-uf6wjk5xxxxxxxxxx

ID da instância.

RegionIdStringSimcn-hangzhou

ID da região à qual a instância source pertence. Use a operação DescribeRegions para consultar a lista de regiões mais recente.

CrossBackupTypeStringNão1

Política usada para salve os arquivos de backup entre regiões da instância. Defina o valor como 1. O valor 1 indica que todos os arquivos de backup entre regiões são salvos.

LogBackupEnabledStringNão1

Status do recurso de backup de log entre regiões na instância. Valores válidos:

  • 0: desativa o recurso.
  • 1: ative o recurso.
Nota É possível ative o backup de log entre regiões apenas quando o backup entre regiões estiver ativado.
BackupEnabledStringNão1

Status do recurso de backup entre regiões na instância. Este parâmetro define se é possível fazer backup de dados e logs. Valores válidos:

  • 0: desativa o recurso.
  • 1: ative o recurso.
Nota Antes de ative o backup entre regiões, configure o parâmetro CrossBackupRegion.
CrossBackupRegionStringNãocn-shanghai

ID da região de destino onde os arquivos de backup entre regiões da instância são armazenados.

RetentTypeIntegerNão1

Política usada para reter os arquivos de backup entre regiões da instância. Defina o valor como 1. O valor 1 indica que os arquivos de backup entre regiões da instância são retidos com base no período de retenção especificado.

RetentionIntegerNão7

Número de dias de retenção dos arquivos de backup entre regiões da instância. Valores válidos: 7 a 1825.

Parâmetros de resposta

ParâmetroTipoExemploDescrição
BackupEnabledStringEnable

Status do recurso de backup entre regiões na instância. Valores válidos:

  • Disable
  • Enable
RegionIdStringcn-hangzhou

ID da região à qual a instância source pertence. Use a operação DescribeRegions para consultar a lista de regiões mais recente.

LogBackupEnabledStringEnable

Status do recurso de backup de log entre regiões na instância. Valores válidos:

  • Disable
  • Enable
RequestIdString50A6059D-6DBB-46C6-A851-1EE93C9013CF

ID da solicitação.

RetentTypeInteger1

Política usada para reter os arquivos de backup entre regiões da instância. Valor padrão: 1. O valor 1 indica que os arquivos de backup entre regiões da instância são retidos com base no período de retenção especificado.

CrossBackupRegionStringcn-shanghai

ID da região de destino onde os arquivos de backup entre regiões da instância são armazenados.

CrossBackupTypeString1

Política usada para salve os arquivos de backup entre regiões da instância. Valor padrão: 1. O valor 1 indica que todos os arquivos de backup entre regiões são salvos.

RetentionInteger15

Número de dias de retenção dos arquivos de backup entre regiões da instância. Valores válidos: 7 a 1825.

DBInstanceIdStringrm-uf6wjk5xxxxxxxxxx

ID da instância.

Exemplos

Exemplos de solicitações

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

Exemplos de respostas de sucesso

Formato 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>

Formato 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
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400

ParameterLeastAssociate

Must input at least one optional parameter.

Erro retornado porque os parâmetros restoreTime e BackupId da instância não podem estar vazios simultaneamente. Configure pelo menos um dos parâmetros e tente novamente.

400

InvalidRegion.Format

Specified Region is not valid.

Erro retornado porque a região especificada é inválida.

400

OperationDenied.SwitchToCrossRegionBackup

Snapshot backup does not support cross region backup storage at present.

Erro retornado porque backups de snapshot não oferecem suporte a armazenamento de backup entre regiõ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.

Erro retornado porque arquivos de backup de snapshot não podem ser armazenados em uma região diferente daquela onde a instância reside. Antes de ative o backup de snapshot, desative o backup entre regiões.

400

OperationDenied.SwitchSnapshotToPhysical

Only physical backup to snapshot backup is supported.

Erro retornado porque a operação oferece suporte apenas à alteração do método de backup físico para o método de backup de snapshot.

403

IncorrectEngineVersion

Current engine version does not support operations.

Erro retornado porque a versão do mecanismo de banco de dados executada na instância não oferece suporte a esta operação.

403

IncorrectDBInstanceType

Current DB instance type does not support this operation.

Erro retornado porque o tipo atual da instância não oferece suporte a esta operação.

403

IncorrectDBInstanceEngine

Current DB Instance engine does not support this operation.

Erro retornado porque o mecanismo de banco de dados da instância não oferece suporte a esta operação.

403

IncorrectDBInstanceLockMode

Current DB instance lock mode does not support this operation.

Erro retornado porque a instância está bloqueada.

403

IncorrectDBInstanceState

Current DB instance state does not support this operation.

Erro retornado porque o estado atual da instância não oferece suporte a esta operação.

404

InvalidDBInstance.NotFound

Specified instance does not exist or not support.

Erro retornado porque a instância não foi encontrada, foi excluída ou não oferece suporte à operação.

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.