Modifique configurações de backup - : Central de Documentação do Alibaba Cloud

Antes de chamar esta operação, verifique se os seguintes requisitos foram atendidos:

A instância não é somente leitura.
A instância está no estado Running.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ModifyBackupPolicy	A operação a ser executada. Defina o valor como ModifyBackupPolicy.
DBInstanceId	String	Sim	rm-uf6wjk5xxxxxxx	O ID da instância. Chame a operação DescribeDBInstances para consultar os IDs das instâncias.
BackupPolicyMode	String	Não	DataBackupPolicy	O tipo de backup a ser realizado. Valores válidos: DataBackupPolicy: backup de dados LogBackupPolicy: backup de log
PreferredBackupTime	String	Não	00:00Z-01:00Z	O horário para realizar o backup. Especifique o horário no padrão ISO 8601, no formato HH:mmZ-HH:mmZ. O horário deve estar em UTC. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
PreferredBackupPeriod	String	Não	Monday	O ciclo de backup. Especifique pelo menos dois dias da semana e separe-os por vírgulas (,). Valores válidos: Monday Tuesday Wednesday Thursday Friday Saturday Sunday Nota Configure uma política de backup usando este parâmetro em conjunto com o parâmetro BackupInterval. Por exemplo, se você definir este parâmetro como Saturday,Sunday e o parâmetro BackupInterval como 30, um backup será realizado a cada 30 minutos aos sábados e domingos. Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
BackupRetentionPeriod	String	Não	7	O número de dias para retenção dos arquivos de backup de dados. Valores válidos: 7 a 730. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
BackupLog	String	Não	Enable	Defina se o recurso de backup de log deve ser ativado. Valores válidos: Enable Disabled Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
LogBackupRetentionPeriod	String	Não	7	O número de dias para retenção dos arquivos de backup de log. Valores válidos: 7 a 730. O período de retenção de backup de log não pode exceder o período de retenção de backup de dados. Nota Se você ativar o recurso de backup de log, poderá especificar o período de retenção do backup de log. Este parâmetro é suportado apenas por instâncias que executam MySQL e PostgreSQL. Este parâmetro entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy ou LogBackupPolicy.
EnableBackupLog	String	Não	1	Defina se o recurso de backup de log deve ser ativado. Valores válidos: True ou 1: o recurso de backup de log está ativado. False ou 0: o recurso de backup de log está desativado. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy.
LocalLogRetentionHours	String	Não	18	O número de horas para retenção dos arquivos de backup de log na instância. Valores válidos: 0 a 168. O valor 0 indica que os arquivos de backup de log não são retidos na instância. O valor 168 é calculado com base na seguinte fórmula: 7 × 24. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy.
LocalLogRetentionSpace	String	Não	30	O uso máximo de armazenamento permitido para arquivos de backup de log na instância. Se o uso de armazenamento para arquivos de backup de log na instância exceder o valor deste parâmetro, o ApsaraDB RDS exclui os arquivos de backup de log mais antigos até que o uso de armazenamento fique abaixo do valor deste parâmetro. Valores válidos:0 a 50. Você pode manter o valor padrão. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy.
HighSpaceUsageProtection	String	Não	Enable	Defina se o ApsaraDB RDS força a exclusão de arquivos de backup de log da instância quando o uso de armazenamento da instância excede 80% ou quando o espaço de armazenamento restante na instância é inferior a 5 GB. Valores válidos: Enable e Disable. Você pode manter o valor padrão. Nota Especifique este parâmetro quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy.
LogBackupFrequency	String	Não	LogInterval	A frequência para fazer backup dos logs da instância. Valores válidos: O valor LogInterval indica que um backup de log é realizado a cada 30 minutos. O valor padrão é igual à frequência de backup de dados. Nota O valor LogInterval é suportado apenas por instâncias que executam SQL Server. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
CompressType	String	Não	4	O formato de compactação dos backups. Valores válidos: 0: os backups não são compactados. 1: a ferramenta zlib compacta backups em arquivos .tar.gz. 2: a ferramenta zlib compacta backups em paralelo. 4: a ferramenta QuickLZ compacta backups em arquivos .xb.gz. Este formato de compactação é suportado apenas por instâncias que executam MySQL 5.6 ou MySQL 5.7. Backups neste formato podem ser usados para restaurar bancos de dados e tabelas individuais. Para obter mais informações, consulte Restaurar bancos de dados e tabelas individuais de uma instância do ApsaraDB RDS for MySQL. 8: a ferramenta QuickLZ compacta backups em arquivos .xb.gz. Este formato de compactação é suportado apenas por instâncias que executam MySQL 8.0. Backups neste formato não podem ser usados para restaurar bancos de dados e tabelas individuais. Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
ArchiveBackupRetentionPeriod	String	Não	365	O número de dias para retenção dos arquivos de backup arquivados. O valor padrão 0 indica que o recurso de arquivamento de backup não está ativado. Valores válidos: 30 a 1095. Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
ArchiveBackupKeepPolicy	String	Não	ByMonth	O intervalo de tempo para retenção dos arquivos de backup arquivados. O número de arquivos de backup arquivados retidos dentro do período de retenção especificado é definido pelo parâmetro ArchiveBackupKeepCount. Valor padrão: 0. Valores válidos: ByMonth ByWeek KeepAll Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
ArchiveBackupKeepCount	Integer	Não	1	O número de arquivos de backup arquivados a serem retidos. Valor padrão: 1. Valores válidos: O valor válido deste parâmetro varia de 1 a 31 quando o parâmetro ArchiveBackupKeepPolicy está definido como ByMonth. O valor válido deste parâmetro varia de 1 a 7 quando o parâmetro ArchiveBackupKeepPolicy está definido como ByWeek. Nota Não é necessário especificar este parâmetro quando o parâmetro ArchiveBackupKeepPolicy está definido como KeepAll. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
ReleasedKeepPolicy	String	Não	None	A política com base na qual o ApsaraDB RDS retém arquivos de backup arquivados caso a instância seja liberada. Valor padrão: None. Valores válidos: None: nenhum arquivo de backup arquivado é retido. Lastest: apenas o arquivo de backup arquivado mais recente é retido. All: todos os arquivos de backup arquivados são retidos. Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
LogBackupLocalRetentionNumber	Integer	Não	60	O número de arquivos de log binário a serem retidos na instância. Valor padrão: 60. Valores válidos: 6 a 100. Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como LogBackupPolicy. Se a instância executar MySQL, você poderá definir este parâmetro como -1. O valor -1 indica que um número ilimitado de arquivos de log binário pode ser retido na instância.
Category	String	Não	Standard	Defina se o recurso de backup em segundos de dígito único deve ser ativado. Esse recurso permite que o ApsaraDB RDS conclua um backup em poucos segundos. Valores válidos: Flash: o recurso de backup em segundos de dígito único está ativado. Standard: o recurso de backup em segundos de dígito único está desativado. Nota Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
BackupInterval	String	Não	30	A frequência para realizar um backup de snapshot na instância. Valores válidos: -1: nenhuma frequência de backup é especificada. 30: um backup de snapshot é realizado uma vez a cada 30 minutos. 60: um backup de snapshot é realizado uma vez a cada 60 minutos. 120: um backup de snapshot é realizado uma vez a cada 120 minutos. 240: um backup de snapshot é realizado uma vez a cada 240 minutos. 480: um backup de snapshot é realizado uma vez a cada 480 minutos. Nota Configure uma política de backup usando este parâmetro em conjunto com o parâmetro PreferredBackupPeriod. Por exemplo, se você definir o parâmetro PreferredBackupPeriod como Saturday,Sunday e o parâmetro BackupInterval como -1, um backup de snapshot será realizado aos sábados e domingos. Se a instância executar PostgreSQL, o parâmetro BackupInterval será suportado apenas quando a instância estiver equipada com SSDs padrão ou ESSDs. Se a instância executar SQL Server, o parâmetro BackupInterval será suportado apenas quando o recurso de backup de snapshot estiver ativado para a instância. Para obter mais informações, consulte Ativar backups de snapshot para uma instância do ApsaraDB RDS for SQL Server. Se você definir o parâmetro Category como Flash, o parâmetro BackupInterval será inválido. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
BackupMethod	String	Não	Physical	O método de backup da instância. Valores válidos: Physical: backup físico Snapshot: backup de snapshot Valor padrão: Physical. Nota Este parâmetro só entra em vigor em instâncias que executam SQL Server com SSDs padrão ou ESSDs. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.
EnableIncrementDataBackup	Boolean	Não	false	Defina se o recurso de backup incremental deve ser ativado. Valores válidos: false: o recurso de backup incremental está desativado. O valor padrão é false. true: o recurso de backup incremental está ativado. Nota Este parâmetro só entra em vigor em instâncias que executam SQL Server com SSDs padrão ou ESSDs. Este parâmetro só entra em vigor quando o parâmetro BackupPolicyMode estiver definido como DataBackupPolicy.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	DA147739-AEAD-4417-9089-65E9B1D8240D	O ID da solicitação.
CompressType	String	4	O formato de compactação dos backups. Valores válidos: 0: os backups não são compactados. 1: os backups são compactados usando a ferramenta zlib. 2: os backups são compactados em paralelo usando a ferramenta zlib. 4: os backups são compactados usando a ferramenta QuickLZ e podem ser usados para restaurar bancos de dados e tabelas individuais. 8: os backups são compactados usando a ferramenta QuickLZ, mas não podem ser usados para restaurar bancos de dados ou tabelas individuais. Este valor é suportado apenas por instâncias que executam MySQL 8.0.
LocalLogRetentionSpace	String	30	O uso máximo de armazenamento permitido para arquivos de backup de log na instância.
LogBackupLocalRetentionNumber	Integer	60	O número de arquivos de log binário retidos na instância.
DBInstanceID	String	rm-uf6wjk5xxxxxxx	O ID da instância.
EnableBackupLog	String	1	Indica se o recurso de backup de log está ativado. Valores válidos: 1: o recurso de backup de log está ativado. 0: o recurso de backup de log está desativado.
LocalLogRetentionHours	Integer	18	O número de horas durante as quais os arquivos de backup de log são retidos na instância.
HighSpaceUsageProtection	String	Disable	Indica se o ApsaraDB RDS força a exclusão de arquivos de backup de log da instância quando o uso de armazenamento da instância excede 80% ou quando o espaço de armazenamento restante na instância é inferior a 5 GB.

Exemplos

Solicitações de exemplo

http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<ModifyBackupPolicyResponse>
      <HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
	<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
	<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
	<LocalLogRetentionHours>18</LocalLogRetentionHours>
	<EnableBackupLog>1</EnableBackupLog>
	<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
    <LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>

Formato JSON

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

{
  "HighSpaceUsageProtection" : "Disable",
  "DBInstanceID" : "rm-bp1z3xxxxx",
  "RequestId" : "E4BF5598-ED12-4406-AAA4-F375428BE741",
  "LocalLogRetentionHours" : "18",
  "EnableBackupLog" : "1",
  "LocalLogRetentionSpace" : "30",
  "LogBackupLocalRetentionNumber" : 60
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidLogBackupFrequency.Malformed	Invalid log backup frequency.	A mensagem de erro retornada porque o valor do parâmetro LogBackupFrequency é inválido. Verifique se a configuração do parâmetro está correta.
400	InvalidBackupRetentionPeriod.Malformed	The specified backup retention period is invalid.	A mensagem de erro retornada porque nenhum período de retenção de backup foi especificado. Especifique um período de retenção de backup. O período de retenção de backup não pode ser inferior a 1 dia nem superior a 30 dias.
400	BackupPropertyNotFound	Backup policy not found	A mensagem de erro retornada porque nenhuma política de backup foi encontrada.
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.	A mensagem de erro retornada porque os arquivos de backup de snapshot não podem ser armazenados em uma região diferente da região onde a instância reside. Antes de ativar o recurso de backup de snapshot, você deve desativar o recurso de backup entre regiões.
403	IncorrectCategory	Current Instance type does not support Category.	A mensagem de erro retornada porque o parâmetro Category não é suportado pelo tipo de instância atual.
403	OperationDenied.SwitchSnapshotToPhysical	Only physical backup to snapshot backup is supported.	A mensagem de erro retornada porque a operação suporta apenas a alteração do método de backup físico para o método de backup de snapshot.
403	OperationDenied.ModifyBackupSwitchOff	The switch is not turned on. It is forbidden to modify the backup mode.	A mensagem de erro retornada porque o recurso de backup entre regiões não está ativado.
403	OperationDenied.ApiForbiddenForLogBackupFrequency	When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.	A mensagem de erro retornada porque a frequência de backup de log não pode ser igual à frequência de backup de dados quando o recurso de backup de snapshot está ativado.
403	OperationDenied.NotSupportedBackupMethod	When the storage is larger than 4000 GB, only snapshot backup is supported.	A mensagem de erro retornada porque a instância suporta apenas backups de snapshot quando o armazenamento é superior a 4.000 GB.
403	OperationDenied.ApiForbidden	Operation is not permitted.	A mensagem de erro retornada porque a operação não é permitida.

Para obter uma lista de códigos de erro, visite o API Error Center.