Todos os produtos
Search

Este produto

    PolarDB:DescribeLogBackupPolicy

    Central de documentação

    PolarDB:DescribeLogBackupPolicy

    Última atualização: Jun 28, 2026

    Consulta a política de retenção de dados para os backups de log de um cluster PolarDB.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    polardb:DescribeLogBackupPolicy

    get

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBClusterId

    string

    Sim

    O ID do cluster.

    Nota

    Você pode chamar a operação DescribeDBClusters para consultar as informações sobre todos os clusters em uma região específica, incluindo os IDs dos clusters.

    pc-*****************

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    LogBackupRetentionPeriod

    integer

    O período de retenção do backup de log. Valores válidos:

    • 3 a 7300: O backup de log é retido por 3 a 7300 dias.

    • -1: Os backups de log são retidos permanentemente.

    Nota

    • Se o recurso de backup avançado estiver ativado, este parâmetro não é recomendado. Use o parâmetro AdvancedLogPolicies em seu lugar.

    7
    RequestId

    string

    O ID da solicitação.

    62EE0051-102B-488D-9C79-D607B8******
    LogBackupAnotherRegionRetentionPeriod

    string

    O período de retenção do backup de log entre regiões. Valores válidos:

    • 0: O recurso de backup de log entre regiões está desativado.

    • 30 a 7300: O backup de log entre regiões é retido por 30 a 7300 dias.

    • -1: Os backups de log entre regiões são retidos permanentemente.

    Nota

      • Ao criar um cluster, o valor padrão é 0. Este valor indica que o recurso de backup de log entre regiões está desativado.

      • Se o recurso de backup avançado estiver ativado, este parâmetro não é recomendado. Use o parâmetro AdvancedLogPolicies em seu lugar.

    0
    LogBackupAnotherRegionRegion

    string

    A região na qual o backup de log entre regiões é armazenado. Para obter informações sobre as regiões que suportam backup entre regiões, consulte Visão geral.

    Nota

    Se o recurso de backup avançado estiver ativado, este parâmetro não é recomendado. Use o parâmetro AdvancedLogPolicies em seu lugar.

    cn-beijing
    EnableBackupLog

    integer

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

    • 0: O recurso está desativado.

    • 1: O recurso está ativado. Por padrão, o recurso de backup de log está ativado e não pode ser desativado.

    Nota

    Se o recurso de backup avançado estiver ativado, este parâmetro não é recomendado. Use o parâmetro AdvancedLogPolicies em seu lugar.

    1
    AdvancedLogPolicies

    object

    AdvancedLogPolicy

    array<object>

    Os detalhes da política de backup de log avançado.

    Nota

    • Este parâmetro não é suportado pelo PolarDB for PostgreSQL (compatível com Oracle) ou PolarDB for PostgreSQL.

    object

    PolicyId

    string

    The ID of the log backup policy.

    Nota

    This parameter is returned only for clusters for which the cross-region log backup feature is enabled.

    1c75zkmqczcd1vbf6f6d05***
    LogRetentionType

    string

    The retention type for the log backup. Valid values:

    • never: The log backups never expire.

    • delay: The log backups are retained for a specified number of days.

    delay
    LogRetentionValue

    string

    The number of days to retain log backups. Valid values:

    • 3 to 7300: The retention period in days.

    • -1: The log backups are retained permanently.

    7
    SrcType

    string

    The source type for the log backup policy. Valid values:

    • db: database cluster

    • level1: level-1 backup

    • level2: level-2 backup

    • level2Cross: level-2 cross-region backup

    level1
    DestType

    string

    The destination type for the log backup policy. Valid values:

    • level1: level-1 backup

    • level2: level-2 backup

    • level2Cross: level-2 cross-region backup

    level2
    EnableLogBackup

    integer

    Indicates whether the log backup feature is enabled. The return value can be:

    • 1: enabled

    • 0: disabled

    1
    SrcRegion

    string

    The source region of the log backup policy.

    cn-hangzhou
    DestRegion

    string

    The destination region of the log backup policy.

    cn-shanghai

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1,
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "PolicyId": "1c75zkmqczcd1vbf6f6d05***",
        "LogRetentionType": "delay",
        "LogRetentionValue": "7",
        "SrcType": "level1",
        "DestType": "level2",
        "EnableLogBackup": 1,
        "SrcRegion": "cn-hangzhou",
        "DestRegion": "cn-shanghai"
      }
    ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.
    404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. The specified DBClusterId parameter does not exist in the current record.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.