Todos os produtos
Search

Este produto

    ApsaraDB for MongoDB:DescribeClusterBackups

    Central de documentação

    ApsaraDB for MongoDB:DescribeClusterBackups

    Última atualização: Jun 28, 2026

    Consulta os conjuntos de backup de cluster para uma instância de cluster sharded do ApsaraDB for MongoDB que usa discos em nuvem.

    Descrição da operação

    Para instâncias de cluster sharded que usam discos em nuvem e foram criadas antes de 19 de outubro de 2023, você deve primeiro chamar a operação TransferClusterBackup para converter backups de shard em backups de cluster.

    Instâncias de cluster sharded que usam discos em nuvem e foram criadas após 19 de outubro de 2023 usam backups de cluster por padrão.

    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:DescribeClusterBackups

    get

    *Instance

    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-bp16cb162771****
    BackupId

    string

    Não

    O ID do backup de cluster.

    5664****
    PageNo

    integer

    Não

    O número da página a ser retornada. O valor deve ser um número inteiro positivo. Valor padrão: 1.

    1
    PageSize

    integer

    Não

    O número de entradas a serem retornadas em cada página. Valores válidos:

    • 30 (Padrão)

    • 50

    • 100

    30
    StartTime

    string

    Não

    O início do intervalo de tempo a ser consultado. Especifique a hora no formato aaaa-MM-ddTHH:mmZ. A hora deve estar no Tempo Universal Coordenado (UTC).

    Nota

    Este parâmetro é inválido se você especificar o parâmetro BackupId.

    2019-03-13T12:11Z
    EndTime

    string

    Não

    O fim do intervalo de tempo a ser consultado. A hora de término deve ser posterior à hora de início. Especifique a hora no formato aaaa-MM-ddTHH:mmZ. A hora deve estar em UTC.

    Nota

    Este parâmetro é inválido se você especificar o parâmetro BackupId.

    2019-03-14T13:10Z
    IsOnlyGetClusterBackUp

    boolean

    Não

    Especifica se devem ser consultadas as informações sobre os nós filhos no backup de cluster. Valores válidos:

    • true: Retorna apenas as informações básicas sobre o backup de cluster, não as informações de backup de todos os nós filhos.

    • false (Padrão): Retorna as informações de backup de todos os nós filhos.

    true
    SrcRegion

    string

    Não

    A região onde a instância reside.

    Nota

    • Este parâmetro é obrigatório quando você consulta os conjuntos de backup de uma instância liberada.

    • Este parâmetro é obrigatório quando você consulta backups com georredudância.

    cn-hangzhou
    DestRegion

    string

    Não

    A região onde o backup com georredudância reside.

    Nota

    Este parâmetro é obrigatório quando você consulta backups com georredudância.

    cn-shanghai
    ResourceGroupId

    string

    Não

    O ID do grupo de recursos.

    rg-xxxx
    BackupJobId

    string

    Não

    O ID do trabalho de backup.

    775051

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    O esquema da resposta.

    RequestId

    string

    O ID da solicitação.

    2F42BB4E-461F-5B55-A37C-53B1141C****
    MaxResults

    integer

    O número máximo de entradas retornadas nesta solicitação.

    10
    PageNumber

    integer

    O número da página retornada.

    1
    PageSize

    integer

    O número de entradas retornadas por página.

    30
    ClusterBackups

    array<object>

    Os detalhes dos conjuntos de backup de cluster. Um backup de cluster contém os conjuntos de backup de todos os nós.

    array<object>

    Os detalhes dos conjuntos de backup de cluster. Um backup de cluster contém os conjuntos de backup de todos os nós.

    IsAvail

    integer

    Indica se o conjunto de backup de cluster é válido. Valores válidos:

    • 1: O conjunto de backup de cluster é válido.

    • 0: Os conjuntos de backup dos nós filhos não estão completos ou falharam.

    1
    ClusterBackupId

    string

    O ID do backup de cluster.

    cb-o8c2ugnxo26kx***
    ClusterBackupStatus

    string

    O status do backup de cluster.

    OK
    ClusterBackupStartTime

    string

    A hora em que o backup de cluster foi iniciado.

    2023-10-16T19:33:20Z
    ClusterBackupSize

    string

    O tamanho do conjunto de backup de cluster, em bytes.

    107374182400
    ClusterBackupEndTime

    string

    A hora em que o backup de cluster foi concluído.

    2023-10-16T19:33:20Z
    ClusterBackupMode

    string

    O modo do backup de cluster.

    Automated
    ExtraInfo

    object

    As informações suplementares. O valor é uma string formatada em JSON.

    RegistryFromHistory

    string

    Indicates whether the backup set was migrated from a historical backup. A value of 1 indicates that the backup was migrated.

    1
    Backups

    array<object>

    Os conjuntos de backup de cada nó filho no backup de cluster.

    array<object>

    Os conjuntos de backup de cada nó filho no backup de cluster.

    BackupId

    string

    The ID of the backup.

    738025367
    InstanceName

    string

    The name of the shard in the MongoDB cluster.

    d-bp16cb162771****

    BackupDownloadURL

    string

    The public URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.

    http://oss.com/xxx
    BackupIntranetDownloadURL

    string

    The internal URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.

    http://oss.com/xxx
    BackupStartTime

    string

    The time when the backup started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

    2023-10-16T19:33:20Z
    BackupEndTime

    string

    The time when the backup finished. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.

    2023-10-16T19:33:20Z
    BackupSize

    string

    The size of the backup file, in bytes.

    77544597650
    IsAvail

    string

    Indicates whether the backup set is available. Valid values:

    • 0: unavailable.

    • 1: available.

    1
    BackupStatus

    string

    The backup status. Valid values:

    • Success: The backup is successful.

    • Failed: The backup failed.

    Success
    BackupName

    string

    The name of the backup.

    12345678.tar.gz
    ExtraInfo

    object

    The information about the instance node that is associated with the backup.

    NodeId

    string

    The ID of the node.

    d-2ze75ab1fa5d****
    StorageSize

    string

    The storage space of the node, in MB.

    20480
    InstanceClass

    string

    The specifications of the node.

    mdb.shard.4x.large.d
    NodeType

    string

    The type of the node.

    db
    Progress

    string

    O progresso do backup em porcentagem. Este parâmetro é retornado apenas para backups que estão em andamento.

    50
    AttachLogStatus

    string

    O status do backup de log anexado. Valores válidos:

    • Init: inicialização.

    • No_Need: Nenhum backup de log anexado está disponível.

    • Running: O backup de log anexado está em andamento.

    • Ready: O backup de log anexado foi concluído.

    • Failed: O backup de log anexado falhou.

    Nota

    Se o valor do parâmetro ClusterBackupStatus for OK, isso indica apenas que o backup completo foi bem-sucedido. Para uma instância de cluster para a qual o backup de log está ativado, o backup de log anexado deve estar concluído antes que você possa executar uma restauração point-in-time ou garantir a consistência dos dados.

    Ready
    EngineVersion

    string

    A versão do mecanismo de banco de dados da instância quando o backup foi criado. Valores válidos:

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    BackupExpireTime

    string

    A hora em que o backup expira. A hora está no formato aaaa-MM-ddTHH:mm:ssZ e é exibida em UTC.

    Importante

    Um valor de "9999-01-01T00:00:00Z" indica que o backup é retido permanentemente.

    2025-03-29T03:47:12Z

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvalidStartTime.Malformed The Specified parameter StartTime is not valid.
    400 InvalidEndTime.Malformed The Specified parameter EndTime is not valid.
    400 InvalidStartTimeAndEndTime.Malformed The Specified parameter StartTime or EndTime is not valid.
    400 InvalidPageSize.Malformed The specified parameter PageSize 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.