CheckCreateDdrDBInstance - ApsaraDB RDS: Central de Documentação do Alibaba Cloud

Verifica previamente se uma instância do ApsaraDB RDS pode ser restaurada entre regiões por meio de um conjunto de backup entre regiões.

Descrição da operação

Mecanismos compatíveis

ApsaraDB RDS for MySQL
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 com atenção para garantir que você compreenda totalmente os pré-requisitos e os impactos desta operação.

Backup entre regiões para o ApsaraDB RDS for MySQL, Restauração entre regiões para o ApsaraDB RDS for MySQL
Backup entre regiões para o ApsaraDB RDS for PostgreSQL, Restauração entre regiões para o ApsaraDB RDS for PostgreSQL
Backup entre regiões para o ApsaraDB RDS for SQL Server, Restauração entre regiões para o ApsaraDB RDS for SQL Server

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

get

*DBInstance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância de destino. Você pode chamar a operação DescribeRegions para consultar o ID da região.	cn-hangzhou
Engine	string	Sim	O mecanismo de banco de dados da instância de destino. Valores válidos: MySQL SQLServer PostgreSQL	MySQL
EngineVersion	string	Sim	A versão do mecanismo de banco de dados da instância de destino. Os valores válidos variam de acordo com o parâmetro Engine: MySQL: 5.5/5.6/5.7/8.0 SQL Server: 2008r2 (SSDs locais premium, descontinuado)/08r2_ent_ha (edição de disco em nuvem, descontinuado)/2012/2012_ent_ha/2012_std_ha/2012_web/2014_std_ha/2016_ent_ha/2016_std_ha/2016_web/2017_std_ha/2017_ent/2019_std_ha/2019_ent PostgreSQL: 10.0/11.0/12.0/13.0/14.0/15.0 Nota Para instâncias do SQL Server, `_ent` indica a Cluster Edition, `_ent_ha` indica a Enterprise Edition, `_std_ha` indica a Standard Edition e `_web` indica a Web Edition.	5.6
DBInstanceClass	string	Sim	O tipo de instância da instância de destino. Para mais informações, consulte Tipos de instância.	rds.mysql.s1.small
DBInstanceStorage	integer	Sim	O armazenamento da instância de destino. Valores válidos: 5 a 2000. O incremento é de 5 GB. Unidade: GB. Para mais informações, consulte Tipos de instância.	20
RestoreType	string	Sim	O método de restauração. Valores válidos: 0 (padrão): restaura dados de um conjunto de backup. Se você definir este parâmetro como 0, também deverá especificar o parâmetro BackupSetId. 1: restaura dados para um ponto no tempo. Se você definir este parâmetro como 1, também deverá especificar os parâmetros RestoreTime, SourceRegion e SourceDBInstanceName.	0
BackupSetId	string	Não	O ID do conjunto de backup usado para restaurar dados. Você pode chamar a operação DescribeCrossRegionBackups para consultar o ID do conjunto de backup. Nota Este parâmetro é obrigatório quando RestoreType é definido como 0.	14358
RestoreTime	string	Não	O ponto no tempo para o qual você deseja restaurar os dados. O ponto no tempo especificado deve ser anterior à hora atual. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota Este parâmetro é obrigatório quando RestoreType é definido como 1.	2019-05-30T03:29:10Z
SourceRegion	string	Não	O ID da região da instância de origem. Nota Este parâmetro é obrigatório quando RestoreType é definido como 1.	cn-hangzhou
SourceDBInstanceName	string	Não	O ID da instância de origem. Nota Este parâmetro é obrigatório quando RestoreType é definido como 1.	rm-uf6wjk5****
ResourceGroupId	string	Não	O ID do grupo de recursos. Você pode chamar a operação DescribeDBInstanceAttribute para consultar o ID do grupo de recursos.	rg-acfmy****

Exemplos de SQL Server

Método 1: Dry run por conjunto de backup

1. Invoque a operação DescribeCrossRegionBackups para obter o ID do conjunto de backup completo

Exemplo de solicitação

{
  "DBInstanceId": "rm-2ze07tklq********",  // ID da instância
  "RegionId": "cn-beijing",                // ID da região da instância
  "CrossBackupRegion": "cn-shenzhen",      // ID da região do conjunto de backup entre regiões
  "StartTime": "2025-04-18T02:47:00Z",     // Hora de início da consulta
  "EndTime": "2025-04-25T02:47:00Z",       // Hora de fim da consulta
  "PageSize": 30,                          // Número de entradas por página
  "PageNumber": 1                          // Número da página
}

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.

{
  "TotalRecordCount": 100,
  "PageRecordCount": 30,
  "RequestId": "7960B6AD-715E-5F0C-AB09-F59B6E76450B",
  "PageNumber": 1,
  "Items": {
    "Item": [
      {
        "BackupMethod": "P",    // Método de backup para backups entre regiões. L: backup lógico. P: backup físico.
        "Category": "Basic",
        "EngineVersion": "2022_web",
        "InstanceId": 35449901,
        "CrossBackupDownloadLink": "https://rdsddrbak-st.oss-cn-shenzhen.aliyuncs.com/cn-beijing_rm-***********",
        "CrossBackupRegion": "cn-shenzhen",
        "CrossBackupSetLocation": "oss",
        "DBInstanceStorageType": "ecs",
        "BackupSetScale": 0,
        "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",    // Tipo de backup entre regiões. F: backup completo. I: backup incremental.
        "CrossBackupId": 18371944,    // ID do arquivo de backup entre regiões
        "Engine": "mssql"
      }
    ]
  },
  "RegionId": "cn-beijing"
}

2. Invoque a operação CheckCreateDdrDBInstance para verificar se a recuperação entre regiões é suportada

Exemplo de solicitação

{
  "RegionId": "cn-shenzhen",      // ID da região da instância de destino
  "Engine": "SQLServer",          // Engine do banco de dados de destino
  "EngineVersion": "2022_web",    // Versão da engine do banco de dados de destino, que deve ser igual à versão da instância de origem
  "DBInstanceClass": "mssql.x2.medium.w1", // Tipo da instância de destino
  "DBInstanceStorage": 100,       // Armazenamento da instância (unidade: GB)
  "RestoreType": "0",             // Método de recuperação. 0: recuperar a partir de um conjunto de backup. 1: recuperar para um ponto no tempo.
  "BackupSetId": "18371944"       // ID do backup completo entre regiões, obtido ao invocar a operação DescribeCrossRegionBackups
}

Exemplo de resposta

Se IsValid for true, uma instância de backup entre regiões poderá ser criada.

{
  "RequestId": "D55083BF-5328-50CA-8D85-40C8815D56AA",
  "IsValid": "true"
}

3. Invoque a operação CreateDdrInstance para recuperar dados do conjunto de backup para uma nova instância

Método 2: Dry run por ponto no tempo

1. Invoque a operação CheckCreateDdrDBInstance para verificar se a recuperação entre regiões é suportada

Exemplo de solicitação

{
  "RegionId": "cn-shenzhen",      // ID da região da instância de destino
  "Engine": "SQLServer",          // Engine do banco de dados de destino
  "EngineVersion": "2022_web",    // Versão da engine do banco de dados de destino, que deve ser igual à versão da instância de origem
  "DBInstanceClass": "mssql.x2.medium.w1", // Tipo da instância de destino
  "DBInstanceStorage": 100,       // Armazenamento da instância (unidade: GB)
  "RestoreType": "1",             // Método de recuperação. 0: recuperar a partir de um conjunto de backup. 1: recuperar para um ponto no tempo.
  "RestoreTime": "2025-04-26T06:40:00Z", // Ponto no tempo para o qual você deseja recuperar os dados
  "SourceRegion": "cn-beijing",   // ID da região da instância de origem
  "SourceDBInstanceName": "rm-2ze07tklq********" // ID da instância de origem
}

Exemplo de resposta

Se IsValid for true, uma instância de backup entre regiões poderá ser criada.

{
  "RequestId": "A1A20D0D-4113-56DC-838A-E211B45D6F36",
  "IsValid": "true"
}

2. Invoque a operação CreateDdrInstance para recuperar dados para uma nova instância usando um ponto no tempo

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
IsValid	string	Indica se uma instância de recuperação de desastres pode ser criada. Valores válidos: true false	true
RequestId	string	O ID da solicitação.	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC

Exemplos

Resposta de sucesso

JSON formato

{
  "IsValid": "true",
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.
400	InvalidRestoreType.Format	Specified restore type is not valid.	O tipo de restauração especificado é inválido. Especifique um tipo de restauração válido.
400	NoBackupSetRegion	BackupSetRegion is absence.	A operação falhou porque a região de backup não existe.
400	IncorrectBackupSetType	Backup set type should be ddr.	A operação falhou porque o tipo de conjunto de backups deve ser DDR.
400	NoSourceInstanceName	No SourceDBInstanceName.	A operação falhou porque o nome da instância de origem não foi especificado.
400	NoAvailableDisasterRestoreBakset	No available disaster restore bakset.	A operação falhou porque nenhum conjunto de recuperação está disponível no momento.
400	IncorrectBackupSetMethod	Current backup set method does not support operations.
400	InvalidBackupType.Format	Specified backup type is not valid.	A operação falhou porque o tipo de backup especificado é inválido.
400	IncorrectEngineVersion	Current engine version does not support operations.	A operação falhou porque a versão do mecanismo DPI da instância de banco de dados atual não suporta esta operação.
400	IncorrectBaksetVersion	Current bakset version does not support operations.	A operação falhou porque a versão atual do conjunto de backups (bakset) não é suportada.
400	CrossRegionUnsupportTDE	Cross-region disaster restore not support TDE bakset.	A recuperação de desastres entre regiões não suporta conjuntos de backup TDE.
400	DisasterRestoreRegionNotMatched	Disaster restore should be operated in the ddr region or source region.	A recuperação de desastres deve ser realizada na região DDR ou na região de origem.
400	InvalidMinorVersion.NotFound	Specified minor version does not exists.	A operação falhou porque a versão especificada do RDS Milvus não existe.
400	InvalidDBInstanceId.MalFormed	The specified parameter DBInstanceId is not valid.	O ID da instância especificado é inválido. Verifique se a instância existe.
400	InvalidEngine.Malformed	Specified engine is not valid.	O parâmetro Engine especificado é inválido. Especifique um valor válido para o parâmetro Engine.
400	InvalidEngineVersion.Malformed	Specified engine version is not valid.	O parâmetro de versão do mecanismo DPI especificado é inválido.
400	MissingUserID	The request is missing a user_id parameter.	O ID do usuário não existe.
400	MissingUID	The request is missing a uid parameter.	A operação falhou porque o UID está ausente na solicitação atual.
400	UserPermissionFailure	The request processing has failed due to user permission.	Você não tem permissões suficientes.
400	InvalidServiceType.Format	Specified service type is not valid.	O tipo de serviço é inválido. Reconfigure-o. Defina o valor como 0 para serviços do Alibaba Cloud ou 1 para serviços JST.
400	InvalidStorage.Format	Specified Storage is not valid.	O valor do parâmetro Storage é inválido. Defina um valor válido para o parâmetro.
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	IncorrectDBType	The current DB type does not support this operation.	A operação falhou porque o tipo de banco de dados atual não suporta esta operação. Use um tipo de banco de dados diferente.
403	IncorrectDBInstance	The current DB instance does not support this operation.	A operação falhou porque a instância atual não oferece suporte a esta operação.
403	ResourceConfigError	The request processing has failed due to resource config error.	O processamento da solicitação falhou devido a um erro de configuração de recurso.
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	RestoreType.NotFound	RestoreType is not found.	O método de restauração (RestoreType) não foi encontrado.
404	InvalidBackupSetID.NotFound	Specified backup set ID does not exist.	O conjunto de backup não existe. Verifique os conjuntos de backup existentes.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	A instância especificada não existe ou não oferece suporte a esta operação.
404	InvalidDBInstanceClass.NotFound	Specified DB instance class is not found.	O tipo de instância especificado é inválido ou foi descontinuado. Verifique se o parâmetro está correto.
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.