Todos os produtos
Search
Central de documentação

ApsaraDB RDS:DescribeCrossRegionBackups

Última atualização: Oct 18, 2026

Consulta os arquivos de backup de dados entre regiões de uma instância do ApsaraDB RDS.

Descrição da operação

Mecanismos suportados

  • ApsaraDB RDS for MySQL (O tipo de armazenamento deve ser SSDs locais premium. Discos em nuvem não são suportados.)

  • ApsaraDB RDS for PostgreSQL

  • ApsaraDB RDS for SQL Server

Documentação de recursos relacionados

Importante Antes de chamar esta operação, leia a documentação do recurso cuidadosamente para compreender totalmente os pré-requisitos e impactos.
Nota

Para consultar arquivos de backup de log entre regiões, consulte DescribeCrossRegionLogBackupFiles.

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

rds:DescribeCrossRegionBackups

get

*DBInstance

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

  • rds:ResourceTag
  • rds:ResourceTag
  • rds:ResourceTag
Nenhuma

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

DBInstanceId

string

Sim

O ID da instância.

rm-uf6wjk5****

RegionId

string

Sim

O ID da região da instância.

cn-hangzhou

CrossBackupRegion

string

Não

O ID da região de destino para o backup entre regiões.

cn-shanghai

CrossBackupId

integer

Não

O ID do arquivo de backup entre regiões.

Nota

Você deve especificar CrossBackupId ou os parâmetros de hora de início e fim (StartTime e EndTime).

14562

StartTime

string

Não

A hora de início da consulta. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.

Nota

Para fusos horários diferentes de UTC+0, você deve subtrair 8 horas da hora real ao especificar este parâmetro.

2024-03-05T02:21:00Z

EndTime

string

Não

A hora de fim da consulta. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.

Nota

Para fusos horários diferentes de UTC+0, você deve subtrair 8 horas da hora real ao especificar este parâmetro.

2024-03-05T02:24:37Z

PageSize

integer

Não

O número de entradas por página. Valores válidos:

  • 30

  • 50

  • 100

Valor padrão: 30.

30

PageNumber

integer

Não

O número da página. Valores válidos: qualquer número inteiro maior que 0 e menor ou igual ao valor máximo do tipo Integer.

Valor padrão: 1.

1

BackupId

integer

Não

O ID do backup do usuário.

603524****

ResourceGroupId

string

Não

O ID do grupo de recursos.

rg-acfmy****

Exemplo de uso do SQL Server

Exemplo de solicitação

{
  "DBInstanceId": "rm-2ze07tklq********",  // The instance ID.
  "RegionId": "cn-beijing",                // The region ID of the instance.
  "CrossBackupRegion": "cn-shenzhen",      // The region ID of the cross-region backup set.
  "StartTime": "2025-04-18T02:47:00Z",     // The start time of the query.
  "EndTime": "2025-04-25T02:47:00Z",       // The end time of the query.
  "PageSize": 30,                          // The number of entries per page.
  "PageNumber": 1                          // The page number.
}

Exemplo de resposta

Na lista de respostas, encontre um conjunto de backup completo onde BackupType seja F e CrossBackupSetFile termine com .zip, e obtenha o valor do campo CrossBackupId. Neste exemplo, o CrossBackupId é 18371944. Você pode então usar este ID para chamar CheckCreateDdrDBInstance para verificar se a restauração entre regiões pode ser realizada.

{
  "TotalRecordCount": 100,
  "PageRecordCount": 30,
  "RequestId": "7960B6AD-715E-5F0C-AB09-F59B6E76450B",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "BackupMethod": "P",    // The backup method for cross-region backups. L: logical backup; P: physical backup.
        "Category": "Basic",
        "EngineVersion": "2022_web",
        "InstanceId": 35449901,
        "CrossBackupDownloadLink": "https://rdsddrbak-st.oss-cn-shenzhen.aliyuncs.com/cn-beijing_rm-***********",
        "CrossBackupRegion": "cn-shenzhen",
        "CrossBackupSetLocation": "oss",    // The storage location of the backup file.
        "DBInstanceStorageType": "ecs",
        "BackupSetScale": 0,    // The backup policy. 0: instance backup; 1: database backup.
        "CrossBackupSetFile": "cn-beijing_rm-*******_hins35449901_2025042310032419855966.zip",
        "CrossBackupSetSize": 9179823,
        "HasBackupTableMeta": "1",
        "RestoreRegions": {
          "RestoreRegion": [
            "cn-shenzhen"
          ]
        },
        "BackupEndTime": "2025-04-23T02:03:36Z",
        "BackupStartTime": "2025-04-23T02:03:24Z",
        "BackupType": "F",    // The cross-region backup type. F: full backup; I: incremental backup.
        "CrossBackupId": 18371944,    // The ID of the cross-region backup file.
        "Engine": "mssql"
      }
    ]
  },
  "RegionId": "cn-beijing"
}

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Os parâmetros de resposta.

EndTime

string

A hora de fim da consulta.

2019-06-15T12:10:00Z

Items

object

Item

array<object>

A lista de backups entre regiões.

array<object>

Os detalhes do backup entre regiões.

BackupEndTime

string

A hora em que o backup foi gerado no lado do ApsaraDB RDS.

2024-03-05T02:23:37Z

BackupMethod

string

O método de backup entre regiões. Valores válidos:

  • L: backup lógico

  • P: backup físico

P

BackupSetScale

integer

A política de backup do arquivo de backup. Valores válidos:

  • 0: backup de instância

  • 1: backup de banco de dados

0

BackupSetStatus

integer

O status do arquivo de backup exportado. Valores válidos:

  • 0: O backup foi concluído.

  • 1: O backup falhou.

0

BackupStartTime

string

A hora de início do backup entre regiões.

2024-03-05T02:22:45Z

BackupType

string

O tipo de backup entre regiões. Valores válidos:

  • F: backup completo

  • I: backup incremental

F

Category

string

A edição da instância. Valores válidos:

  • Basic: Basic Edition

  • HighAvailability: High Availability

  • Finance: RDS Enterprise Edition (suportado apenas no site da China)

HighAvailability

ConsistentTime

string

O ponto no tempo dos dados no arquivo de backup.

2024-03-05T02:22:54Z

CrossBackupId

integer

O ID do arquivo de backup entre regiões.

1249****

CrossBackupRegion

string

O ID da região de destino para o backup entre regiões.

cn-shanghai

CrossBackupSetFile

string

O nome do pacote compactado para o arquivo de backup entre regiões.

cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb

CrossBackupSetLocation

string

O local de armazenamento do arquivo de backup.

oss

CrossBackupSetSize

integer

O tamanho do arquivo de backup entre regiões. Unidade: bytes.

5312836

DBInstanceStorageType

string

O tipo de armazenamento. Valores válidos:

  • local_ssd: SSDs locais premium

  • cloud_ssd: SSDs padrão

  • cloud_essd: ESSDs

ssd

Engine

string

O mecanismo de banco de dados.

mysql

EngineVersion

string

A versão do mecanismo de banco de dados.

5.6

InstanceId

integer

O ID da instância. Este parâmetro é usado para identificar se o conjunto de backup foi gerado a partir da instância primária ou secundária.

8161***

RestoreRegions

object

RestoreRegion

array

A lista de regiões onde o arquivo de backup pode ser restaurado.

string

A lista de regiões onde o arquivo de backup pode ser restaurado.

"cn-hangzhou", "cn-shanghai"

PageNumber

integer

O número da página. Valores válidos: qualquer número inteiro maior que 0 e menor ou igual ao valor máximo do tipo Integer.

Valor padrão: 1.

1

PageRecordCount

integer

O número de arquivos de backup na página atual.

30

RegionId

string

O ID da região da instância.

cn-hangzhou

RequestId

string

O ID da solicitação.

60912B41-7579-4B5D-B289-8856030F0A6A

StartTime

string

A hora de início da consulta.

2019-05-30T12:10:00Z

TotalRecordCount

integer

O número total de entradas.

100

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2019-06-15T12:10:00Z",
  "Items": {
    "Item": [
      {
        "BackupEndTime": "2024-03-05T02:23:37Z",
        "BackupMethod": "P",
        "BackupSetScale": 0,
        "BackupSetStatus": 0,
        "BackupStartTime": "2024-03-05T02:22:45Z",
        "BackupType": "F",
        "Category": "HighAvailability",
        "ConsistentTime": "2024-03-05T02:22:54Z",
        "CrossBackupDownloadLink": "http://rdsddrbak-shanghai.oss-cn-shanghai.aliyuncs.com/****",
        "CrossBackupId": 0,
        "CrossBackupRegion": "cn-shanghai",
        "CrossBackupSetFile": "cn-hangzhou_rm-****_hins81xxx_data_20190612134426_qp.xb",
        "CrossBackupSetLocation": "oss",
        "CrossBackupSetSize": 5312836,
        "DBInstanceStorageType": "ssd",
        "Engine": "mysql",
        "EngineVersion": "5.6",
        "InstanceId": 0,
        "RestoreRegions": {
          "RestoreRegion": [
            "\"cn-hangzhou\", \"cn-shanghai\""
          ]
        }
      }
    ]
  },
  "PageNumber": 1,
  "PageRecordCount": 30,
  "RegionId": "cn-hangzhou",
  "RequestId": "60912B41-7579-4B5D-B289-8856030F0A6A",
  "StartTime": "2019-05-30T12:10:00Z",
  "TotalRecordCount": 100
}

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400 ParameterAbsence Necessary param is absence.
400 InvalidParameters.Format Specified parameter is not valid.
400 InvalidRegion.Format Specified Region is not valid. A região especificada é inválida. Verifique se o parâmetro da região está correto.
400 InvalidStartTime.Format Specified start time is not valid. O formato da hora de início está incorreto. A hora deve estar no formato GMT padrão: YYYY-MM-DDThh:mmZ. Exemplos: DescribeDBInstancePerformance: 2012-06-11T15:00Z. DescribeErrorLogs: 2011-06-11T16:00Z.
400 InvalidEndTime.Format Specified end time is not valid. A hora de término enviada é inválida. Envie as informações corretas.
400 InvalidTime.Format Specified time is not valid. A operação falhou porque o formato de hora está incorreto.
400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. Operações individuais não são permitidas para instâncias agrupadas.
400 Price.PricingPlanResultNotFound Pricing plan price result not found. O resultado de preços para o plano de preços não foi encontrado.
400 Order.NoRealNameAuthentication You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. Você não concluiu a verificação de nome real e não atende aos requisitos de compra. Faça login em Despesas e Custos para concluir a verificação de nome real.
400 InsufficientAvailableQuota Your account quota limit is less than 0, please recharge before trying to purchase. O saldo disponível da sua conta é menor que 0. Recarregue sua conta antes de tentar fazer uma compra.
400 CommodityServiceCalling.Exception Failed to call commodity service. A chamada para o serviço de produtos falhou.
400 RegionDissolvedEOM Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. O Alibaba Cloud planeja otimizar e ajustar a região atual, e os serviços em nuvem nesta região cessarão as operações. Para garantir a continuidade dos negócios e uma transição suave para a migração de dados, você não pode realizar novos pedidos de compra no momento. Agradecemos sua compreensão e apoio.
400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. O módulo especificado é inválido. Adquira um módulo válido.
400 RegionEndTimeDissolvedAustralia Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. A região foi desativada.
400 Price.CommoditySys Commodity system call exception. Ocorreu uma exceção ao chamar o sistema de produtos.
400 Pay.InsufficientBalance Insufficient available balance.
400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. O período de assinatura selecionado é inválido. Selecione novamente o período de assinatura.
400 pay.noCreditCard Account not bound to credit card. A conta não está vinculada a um cartão de crédito.
400 Order.InstHasUnpaidOrder There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. Você tem pedidos não pagos para o serviço selecionado. Pague ou cancele os pedidos não pagos antes de fazer um novo pedido.
400 noAvailablePaymentMethod No payment method is specified for your account. We recommend that you add a payment method. Nenhum método de pagamento está especificado para a sua conta. Adicione um método de pagamento.
400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Suas informações estão incompletas. Complete suas informações antes de prosseguir.
400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Sua conta está em um estado anormal. Entre em contato com o suporte ao cliente para obter detalhes.
400 Api.NotSupport Specified api is not supported. A operação de API atual não é suportada.
400 ContainForbiddenLabelError There is a label that prohibits placing orders. Please contact your distributor for assistance. Uma tag que proíbe a realização de pedidos está presente. Entre em contato com seu distribuidor para obter assistência.
400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. A instância especificada não existe. Verifique se a instância existe e se não foi excluída.
400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type O tipo de instância atual não suporta este tipo de armazenamento.
400 InvalidParam Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. A operação falhou porque o parâmetro especificado é inválido.
400 KmsApiError User secret key invalid. A chave do usuário é inválida.
400 System.SaleValidateFailed Sales expression validation system error.
400 Abs.InvalidAccount.NotFound account is not found. A conta não existe.
400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. A execução do comando SQL falhou ou atingiu o tempo limite.
400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. A versão atual do mecanismo de banco de dados da instância não suporta o arquivamento de dados frios.
400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. A versão atual do kernel não suporta o arquivamento de dados frios.
400 IncorrectTargetClasscode The current instance type does not support this operation. O tipo de instância atual não suporta esta operação.
400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. O nome do endpoint está duplicado. Reconfigure a string de conexão.
400 RequiredParam.NotFound Required input param is not found. Os parâmetros obrigatórios não foram fornecidos.
400 Parameters.Invalid Parameter error, please check the parameters. O parâmetro especificado é inválido. Verifique os parâmetros.
400 BackupPolicyNotSupport Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. O arquivamento de dados não suporta backups entre regiões ou snapshots em segundos. Verifique a política de backup.
400 InvalideStatus.Format The instance status does not support this operation. O status atual da instância não oferece suporte a esta operação.
400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. A política de retenção para backups arquivados após a liberação da instância é inválida.
400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. Esta operação não é suportada para o tipo de mecanismo de banco de dados da instância.
400 Pay.NoCreditCard No credit cards.
400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. Esta operação não é suportada para instâncias do tipo VPC.
400 MirrorInsExists Specified DB instance mirror ins already existed. A imagem da instância de banco de dados atual já existe.
400 UnsupportedClassCode The specified DB instance class stops selling. O tipo de instância não está mais disponível para compra.
400 InvalidBackupSet The specified database does not exist in the backup set. O banco de dados especificado não existe no conjunto de backups.
400 OrdTCommodityQueryError Failed to query for product. Falha ao consultar o produto.
400 ProductInstanceReleased The instance has been released. Please check before placing the order. A instância foi liberada. Verifique o status da instância antes de fazer um pedido.
400 RegionEndTimeDissolvedIndia The region is no longer supported. A região foi desativada.
500 ExternalFailure The request processing has failed due to external service failure. A solicitação de serviço falhou. Tente novamente mais tarde.
500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. A solicitação de serviço falhou. Tente novamente mais tarde ou entre em contato com o suporte técnico.
500 InvokeProxyFailure The request processing has failed due to service failure of rds api. O processamento da solicitação falhou devido a uma falha no serviço da API do RDS.
403 CrossBackupNotSupport Specified region not support cross region backup. A região especificada não suporta backup entre regiões.
403 OrderStatus.UnPaid The specified db instance has unpaid order. A instância possui pedidos não pagos. Pague os pedidos e tente novamente.
403 InvalidReduceDiskSize The storage capacity after the scale-down must be larger than the used amount. A capacidade de destino para redução de escala não pode ser menor que o uso de armazenamento atual.
403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd. Esta operação não é suportada para SSDs padrão. Faça upgrade para ESSDs.
403 InvalidUserOperatorPermission The user permission does not support this operation. Você não tem as permissões necessárias para realizar esta operação.
403 InvalidVswitchId Specified conn vswitch id is not valid. O VSwitchId especificado é inválido ou está vazio.
403 IncorrectMinorVersion Current engine minor version does not support operations. A versão secundária atual do mecanismo não suporta esta operação.
403 OperationDenied.ZoneResource There is no available zone for inventory. Nenhuma zona com estoque disponível foi encontrada.
403 NotInFlowController Sorry,no permission. Este recurso não está disponível para usuários de nuvem que não pertencem a um grupo. Você não tem as permissões necessárias.
403 InvalidKmsKey Kms key is disabled. A chave KMS especificada está desativada.
403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. A operação falhou porque o código de especificação especificado não suporta o número de endpoints. Verifique o número de shards e o número atual de endpoints.
404 InvalidPage.notFound Page not found. O parâmetro especificado não foi encontrado. Verifique e valide o parâmetro.
404 InvalidDBInstance.NotFound Specified instance does not exist or not support. A instância especificada não existe ou não oferece suporte a esta operação.
404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. A instância atual não está autorizada a acessar o Key Management Service (KMS).
404 Request.NotFound The requested resource is not available. O recurso solicitado não está disponível.
404 HostInfo.NotFound The specified host info is not found. As informações do host especificado não existem.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.