Todos os produtos
Search

Este produto

    :Consultar configurações de backup

    Central de documentação

    :Consultar configurações de backup

    Última atualização: Jun 26, 2026

    Chame a operação DescribeBackupPolicy para consultar as configurações de backup de uma instância.

    Depuração

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

    Parâmetros de solicitação

    Parâmetro Tipo Obrigatório Exemplo Descrição
    Action String Sim DescribeBackupPolicy

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

    DBInstanceId String Sim rm-uf6wjk5xxxxxxx

    ID da instância.

    BackupPolicyMode String Não DataBackupPolicy

    Tipo de backup. Valores válidos:

    • DataBackupPolicy: backup de dados
    • LogBackupPolicy: backup de log
    CompressType String Não 1

    Método de compactação dos dados de backup. Valores válidos:

    • 0: Dados de backup não compactados.
    • 1: Compactação com zlib.
    • 2: Compactação com zlib usando múltiplas threads em paralelo por backup.
    • 4: Compactação com QuickLZ; permite restaurar bancos de dados e tabelas individuais.
    • 8: Compactação com QuickLZ; não permite restaurar bancos de dados ou tabelas individuais. Disponível apenas para instâncias MySQL 8.0.
    ReleasedKeepPolicy String Não Lastest

    Política de retenção de arquivos de backup arquivados após a liberação da instância. Valores válidos:

    • None: Nenhum arquivo de backup arquivado retido.
    • Lastest: Apenas o último arquivo de backup arquivado retido.
    • All: Todos os arquivos de backup arquivados retidos.

    Parâmetros de resposta

    Parâmetro Tipo Exemplo Descrição
    LogBackupRetentionPeriod Integer 7

    Período de retenção dos arquivos de backup de log, em dias.

    ArchiveBackupKeepPolicy String ByMonth

    Ciclo de retenção dos arquivos de backup arquivados.

    ArchiveBackupKeepCount String 1

    Quantidade de arquivos de backup arquivados retidos.

    LocalLogRetentionHours Integer 0

    Tempo de retenção dos arquivos de backup de log na instância, em horas.

    BackupRetentionPeriod Integer 7

    Período de retenção dos arquivos de backup de dados, em dias.

    RequestId String B87E2AB3-B7C9-4394-9160-7F639F732031

    ID da solicitação.

    PreferredBackupPeriod String Monday,Wednesday,Friday,Sunday

    Ciclo de execução do backup. Separe vários valores com vírgulas (,). Valores válidos:

    • Monday
    • Tuesday
    • Wednesday
    • Thursday
    • Friday
    • Saturday
    • Sunday
    CompressType String 1

    Método de compactação dos dados de backup. Valores válidos:

    • 0: Dados de backup não compactados.
    • 1: Compactação com zlib.
    • 2: Compactação com zlib usando múltiplas threads em paralelo por backup.
    • 4: Compactação com QuickLZ; permite restaurar bancos de dados e tabelas individuais.
    • 8: Compactação com QuickLZ; não permite restaurar bancos de dados ou tabelas individuais. Disponível apenas para instâncias MySQL 8.0.
    SupportReleasedKeep Integer 0

    Parâmetro reservado.

    LocalLogRetentionSpace String 30

    Uso máximo de disco permitido para arquivos de backup de log na instância.

    SupportVolumeShadowCopy Integer 1

    Indica se a instância oferece suporte a backups de snapshot. Valores válidos:

    • 1: A instância oferece suporte a backups de snapshot.
    • 0: A instância não oferece suporte a backups de snapshot.
    Nota Este parâmetro é retornado apenas quando a instância executa SQL Server.
    BackupMethod String Physical

    Método de backup da instância. Valores válidos:

    • Physical: backup físico
    • Snapshot: backup de snapshot
    Nota Este parâmetro é retornado apenas quando a instância executa SQL Server e utiliza SSDs padrão ou SSDs aprimorados (ESSDs).
    LogBackupFrequency String LogInterval

    Frequência de backup de logs. Valores válidos:

    • LogInterval: Backups de log realizados a cada 30 minutos.
    • Valor padrão: igual ao valor do parâmetro PreferredBackupPeriod.
    Nota O parâmetro LogBackupFrequency é retornado apenas quando a instância executa SQL Server.
    PreferredNextBackupTime String 2018-01-19T15:15Z

    Horário da próxima execução de backup. Segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mmZ, exibido em UTC.

    HighSpaceUsageProtection String Enable

    Indica se o recurso de exclusão de backup de log está ativado. Esse recurso exclui arquivos de log binário se o uso do disco exceder 80% ou se o espaço restante na instância for inferior a 5 GB. Valores válidos:

    • Disable
    • Enable
    ArchiveBackupRetentionPeriod String 365

    Período de retenção dos arquivos de backup arquivados, em dias.

    BackupInterval String 30

    Intervalo de backup. Unidade: minutos.

    • Para instâncias MySQL, o intervalo corresponde ao valor do parâmetro Snapshot Backup Start Time (não ao Snapshot Backup Period) no console do ApsaraDB RDS. Para mais informações, consulte Fazer backup de uma instância do ApsaraDB RDS for MySQL.
    • Para instâncias SQL Server, o intervalo equivale à frequência de backup de log.
    ReleasedKeepPolicy String None

    Política de retenção de arquivos de backup arquivados após a liberação da instância. Valores válidos:

    • None: Nenhum arquivo de backup arquivado retido.
    • Lastest: Apenas o último arquivo de backup arquivado retido.
    • All: Todos os arquivos de backup arquivados retidos.
    PreferredBackupTime String 15:00Z-16:00Z

    Horário de execução do backup de dados. Segue o padrão ISO 8601 no formato HH:mmZ-HH:mmZ, exibido em UTC.

    LogBackupLocalRetentionNumber Integer 60

    Quantidade de arquivos de log binário retidos na instância.

    Category String Standard

    Indica se o recurso de backup em segundos de dígito único está ativado. Esse recurso permite que o ApsaraDB RDS conclua um backup em segundos de dígito único. Valores válidos:

    • Flash: Recurso de backup em segundos de dígito único ativado.
    • Standard: Recurso de backup em segundos de dígito único desativado.
    Nota Este parâmetro entra em vigor apenas quando você defina o parâmetro BackupPolicyMode como DataBackupPolicy.
    EnableBackupLog String 1

    Indica se o recurso de backup de log está ativado. Valores válidos:

    • 1: Recurso de backup de log ativado.
    • 0: Recurso de backup de log desativado.
    BackupLog String Enable

    Status de ativação do backup de log. Valores válidos:

    • Enable
    • Disabled
    EnableIncrementDataBackup Boolean True

    Indica se o backup incremental está ativado. Valores válidos:

    • True: Backup incremental ativado.
    • False: Backup incremental desativado.

    Exemplos

    Solicitações de exemplo

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

    Respostas de sucesso de exemplo

    Formato XML

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

<DescribeBackupPolicyResponse>
<Category>Standard</Category>
<ArchiveBackupRetentionPeriod>0</ArchiveBackupRetentionPeriod>
<RequestId>292884FE-D689-47A2-9829-C05E63366201</RequestId>
<Duplication/>
<ReleasedKeepPolicy>None</ReleasedKeepPolicy>
<ArchiveBackupKeepPolicy>ByMonth</ArchiveBackupKeepPolicy>
<PreferredBackupTime>00:00Z-01:00Z</PreferredBackupTime>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<PreferredNextBackupTime>2021-01-07T00:40Z</PreferredNextBackupTime>
<HighSpaceUsageProtection>Enable</HighSpaceUsageProtection>
<CompressType>1</CompressType>
<LogBackupFrequency>LogInterval</LogBackupFrequency>
<PreferredBackupPeriod>Tuesday,Thursday,Saturday</PreferredBackupPeriod>
<ArchiveBackupKeepCount>1</ArchiveBackupKeepCount>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
<BackupLog>Enable</BackupLog>
<EnableBackupLog>1</EnableBackupLog>
<SupportReleasedKeep>0</SupportReleasedKeep>
<SupportVolumeShadowCopy>1</SupportVolumeShadowCopy>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<BackupRetentionPeriod>10</BackupRetentionPeriod>
<DuplicationContent/>
<BackupInterval>30</BackupInterval>
</DescribeBackupPolicyResponse>

    Formato JSON

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

{
  "Category" : "Standard",
  "ArchiveBackupRetentionPeriod" : 0,
  "RequestId" : "292884FE-D689-47A2-9829-C05E63366201",
  "Duplication" : "",
  "ReleasedKeepPolicy" : "None",
  "ArchiveBackupKeepPolicy" : "ByMonth",
  "PreferredBackupTime" : "00:00Z-01:00Z",
  "LocalLogRetentionHours" : "18",
  "PreferredNextBackupTime" : "2021-01-07T00:40Z",
  "HighSpaceUsageProtection" : "Enable",
  "CompressType" : "1",
  "LogBackupFrequency" : "LogInterval",
  "PreferredBackupPeriod" : "Tuesday,Thursday,Saturday",
  "ArchiveBackupKeepCount" : 1,
  "LogBackupRetentionPeriod" : "7",
  "LogBackupLocalRetentionNumber" : 60,
  "BackupLog" : "Enable",
  "EnableBackupLog" : "1",
  "SupportReleasedKeep" : 0,
  "SupportVolumeShadowCopy" : 1,
  "LocalLogRetentionSpace" : "30",
  "BackupRetentionPeriod" : 10,
  "DuplicationContent" : "",
  "BackupInterval" : "30"
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição

    400

    IO.Exception

    IO exception, retry later.

    Erros de E/S ocorreram.

    400

    InternalFailure

    Internal failure, retry later.

    Falha interna no processamento da solicitação. Tente novamente mais tarde.

    400

    InvalidParameter.OwnerAccount

    The specified parameter OwnerAccount is not valid.

    O valor especificado para o parâmetro OwnerAccount é inválido. Verifique o valor.

    404

    InvalidDBInstance.NotFound

    Specified instance does not exist or not support.

    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 API Error Center.