Todos os produtos
Search

Este produto

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    Central de documentação

    ApsaraDB for MongoDB:DescribeAdvancedBackupPolicy

    Última atualização: Oct 08, 2026

    Consulta a política de backup avançada.

    Descrição da operação

    Consulta a política de backup avançada. Esta operação é compatível apenas com instâncias de conjunto de réplicas de disco em nuvem e de cluster fragmentado de disco em nuvem.

    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

    dds:DescribeAdvancedBackupPolicy

    get

    *Instância.

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBInstanceId

    string

    Sim

    O ID da instância.

    dds-bp18b0934e70****

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    O ID da solicitação.

    111E7B16-0A87-4CBA-B271-F34AD61E099F
    DBInstanceId

    string

    O ID da instância.

    dds-bp14bf67a76d****
    PreferredBackupTime

    string

    O horário de backup no formato HH:mmZ-HH:mmZ (horário UTC).

    09:00Z-10:00Z
    SnapshotBackupType

    string

    O tipo de backup de snapshot. Valores válidos:

    • Flash: backup em segundos.

    • Standard: backup padrão.

    Valores válidos:

    • Standard :

      Backup padrão.

    • Flash :

      Backup em segundos.

    Standard
    BackupRetentionPolicyOnClusterDeletion

    integer

    A política de retenção de dados de backup. Valores válidos:

    • 0: Todos os conjuntos de backup da instância são excluídos imediatamente quando a instância é liberada.

    • 1: O último conjunto de backup é retido usando a retenção de longo prazo (LTR) quando a instância é liberada.

    • 2: Todos os conjuntos de backup são retidos usando a retenção de longo prazo (LTR) quando a instância é liberada.

    Valores válidos:

    • 0 :

      Exclui imediatamente todos os conjuntos de backup.

    • 1 :

      Retém o último conjunto de backup usando a retenção de longo prazo (LTR)

    • 2 :

      Retém todos os conjuntos de backup usando a retenção de longo prazo (LTR)

    2
    PreferredNextBackupTime

    string

    O intervalo de tempo no qual o backup é iniciado. O formato é HH:mmZ-HH:mmZ (horário UTC), como 01:00Z-02:00Z. O backup é iniciado em um horário dentro deste intervalo de tempo.

    2024-06-19T19:11Z
    AdvancedBackupDataPolicies

    array<object>

    A lista de políticas de backup.

    object

    PolicyId

    string

    O ID da política de backup.

    xxxxxx
    ActionType

    string

    O tipo de ação. Valores válidos:

    • DELETE: exclui.

    • CREATE: cria.

    • UPDATE: atualiza.

    xx
    RetentionType

    string

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

    • never: retenção de longo prazo (LTR).

    • delay: retenção por um número fixo de dias.

    Valores válidos:

    • never :

      Retenção de longo prazo (LTR)

    • delay :

      Retenção por um número fixo de dias.

    delay
    RetentionPeriod

    integer

    O número de dias para reter o backup.

    7
    BackupPolicy

    string

    O tipo de agendamento da política de backup avançada. Valores válidos:

    • dayOfWeek: agendamento semanal.

    • dayOfMonth: agendamento mensal.

    • dayOfYear: agendamento anual.

    • backupInterval: agendamento de intervalo fixo (backup de alta frequência).

    Valores válidos:

    • dayOfWeek :

      Agendamento semanal.

    • dayOfMonth :

      Agendamento mensal.

    • dayOfYear :

      Agendamento anual.

    • backupInterval :

      Agendamento de intervalo fixo (backup de alta frequência)

    dayOfWeek
    PreferredBackupPeriod

    string

    O ciclo de backup.

    • Se BackupPolicy=dayOfWeek: 1,2,3,4,5,6,7 indica de segunda a domingo.

    • Se BackupPolicy=dayOfMonth: 1,3,-1 indica o 1º, o 3º e o último dia de cada mês.

    • Se BackupPolicy=dayOfYear: 01-07 indica 7 de janeiro.

    • Se BackupPolicy=backupInterval: 30 indica um backup a cada 30 minutos.

    1,2,3
    SrcRegion

    string

    A região onde a instância reside.

    cn-beijing
    SrcType

    string

    O tipo de origem da política de backup. Valores válidos:

    • db: backup na mesma região.

    • level1: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup entre regiões.

    • db :

      Backup na mesma região.

    db
    DestRegion

    string

    A região de destino da política de backup.

    cn-beijing
    DestType

    string

    O tipo de destino da política de backup. Valores válidos:

    • level1: backup na mesma região.

    • level2Cross: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup na mesma região.

    • level2Cross :

      Backup entre regiões.

    level1
    PreserveOneEachHour

    boolean

    Especifica se o backup esparso dentro de uma hora deve ser ativado. Valores válidos:

    • true: Quando a frequência de backup é em minutos, todos os snapshots tirados dentro de 1 hora do horário atual são retidos. Para snapshots tirados há mais de 1 hora, mas dentro de 24 horas do horário atual, apenas o primeiro snapshot após cada hora cheia é retido.

    • false: O backup esparso dentro de uma hora é desativado. Todos os snapshots dentro do período de retenção de backup de alta frequência são retidos.

    False
    AdvancedBackupLogPolicies

    array<object>

    A lista de políticas de backup de logs.

    object

    EnableLogBackup

    integer

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

    • 1: ativado.

    • 0: desativado.

    Valores válidos:

    • 0 :

      Desativado.

    • 1 :

      Ativado.

    1
    RetentionType

    string

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

    • never: retenção de longo prazo (LTR).

    • delay: retenção por um número fixo de dias.

    Valores válidos:

    • never :

      Retenção de longo prazo (LTR)

    • delay :

      Retenção por um número fixo de dias.

    delay
    RetentionPeriod

    string

    O número de dias para reter o backup de logs. Este parâmetro entra em vigor apenas quando RetentionType é definido como delay.

    4
    SrcRegion

    string

    A região onde a instância de origem reside.

    cn-hangzhou
    SrcType

    string

    O tipo de origem da política de backup de logs. Valores válidos:

    • db: backup na mesma região.

    • level1: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup entre regiões.

    • db :

      Backup na mesma região.

    et
    DestRegion

    string

    A região de destino da política de backup de logs.

    cn-guangzhou
    DestType

    string

    O tipo de destino da política de backup de logs. Valores válidos:

    • level1: backup na mesma região.

    • level2Cross: backup entre regiões.

    Valores válidos:

    • level1 :

      Backup na mesma região.

    • level2Cross :

      Backup entre regiões.

    RDS
    PolicyId

    string

    O ID da política de backup de logs. Este campo existe apenas para políticas de backup de logs entre regiões.

    xxxx

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E099F",
  "DBInstanceId": "dds-bp14bf67a76d****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "SnapshotBackupType": "Standard",
  "BackupRetentionPolicyOnClusterDeletion": 2,
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "AdvancedBackupDataPolicies": [
    {
      "PolicyId": "xxxxxx",
      "ActionType": " xx",
      "RetentionType": "delay",
      "RetentionPeriod": 7,
      "BackupPolicy": "dayOfWeek",
      "PreferredBackupPeriod": "1,2,3",
      "SrcRegion": "cn-beijing",
      "SrcType": "db",
      "DestRegion": "cn-beijing",
      "DestType": "level1",
      "PreserveOneEachHour": true
    }
  ],
  "AdvancedBackupLogPolicies": [
    {
      "EnableLogBackup": 1,
      "RetentionType": "delay",
      "RetentionPeriod": "4",
      "SrcRegion": "cn-hangzhou",
      "SrcType": "et",
      "DestRegion": "cn-guangzhou",
      "DestType": "RDS",
      "PolicyId": "xxxx"
    }
  ]
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvalidPreferredBackupPeriod.Malformed Specified parameter PreferredBackupPeriod is not valid.
    400 InvalidPreferredBackupTime.Malformed Specified parameter PreferredBackupTime is not valid.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.