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

Ativa a Criptografia de Dados Transparente (TDE) para uma instância do ApsaraDB RDS e modifica o status de criptografia.

Descrição da operação

Mecanismos de banco de dados 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 para compreender totalmente os pré-requisitos e os impactos.

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

update

*DBInstance

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

rds:ResourceTag
rds:TDEStatus

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar o ID da instância.	rm-uf6wjk5****
TDEStatus	string	Sim	O status do TDE. Valores válidos: Enabled Disabled	Enabled
DBName	string	Não	Os nomes dos bancos de dados para os quais você deseja ativar o TDE. Você pode especificar vários nomes de bancos de dados separados por vírgulas (,). Podem ser especificados no máximo 50 nomes de bancos de dados. Nota Este parâmetro é obrigatório e ativo apenas para instâncias que executam o SQL Server 2019 Standard Edition, SQL Server 2022 Standard Edition, SQL Server 2025 Standard Edition ou uma instância do SQL Server Enterprise.	testDB
EncryptionKey	string	Não	O ID da chave personalizada. Nota Este parâmetro está disponível apenas para instâncias do ApsaraDB RDS for MySQL ou ApsaraDB RDS for PostgreSQL.	749c1df7-**---**
RoleArn	string	Não	O descritor de recurso global da função, que é usado para especificar a função. Para obter detalhes, consulte Visão geral das funções do RAM. Nota Este parâmetro está disponível apenas para instâncias do ApsaraDB RDS for MySQL e ApsaraDB RDS for PostgreSQL.	acs:ram::1406926****:role/aliyunrdsinstanceencryptiondefaultrole
Certificate	string	Não	O arquivo de certificado. Formato: Endpoint público: `oss-<region ID>.aliyuncs.com:<bucket name>:<certificate file name (with extension)>` Endpoint de rede interna: `oss-<region ID>-internal.aliyuncs.com:<bucket name>:<certificate file name (with extension)>` Nota Este parâmetro está ativo apenas para instâncias que executam o SQL Server 2019 Standard Edition, SQL Server 2022 Standard Edition, SQL Server 2025 Standard Edition ou uma instância do SQL Server Enterprise. Você pode chamar a operação DescribeRegions para consultar os IDs de região disponíveis.	oss-ap-southeast-1.aliyuncs.com:****:key.cer
PrivateKey	string	Não	O arquivo de chave privada. Formato: Endpoint público: `oss-<region ID>.aliyuncs.com:<bucket name>:<private key file name (with extension)>` Endpoint de rede interna: `oss-<region ID>-internal.aliyuncs.com:<bucket name>:<private key file name (with extension)>` Nota Este parâmetro está ativo apenas para instâncias que executam o SQL Server 2019 Standard Edition, SQL Server 2022 Standard Edition, SQL Server 2025 Standard Edition ou uma instância do SQL Server Enterprise. Você pode chamar a operação DescribeRegions para consultar os IDs de região disponíveis.	oss-ap-southeast-1.aliyuncs.com:****:key.pvk
PassWord	string	Não	A senha do certificado. Nota Este parâmetro está ativo apenas para instâncias que executam o SQL Server 2019 Standard Edition, SQL Server 2022 Standard Edition, SQL Server 2025 Standard Edition ou uma instância do SQL Server Enterprise.	1qaz@WSX
IsRotate	boolean	Não	Especifica se a chave deve ser rotacionada. Valores válidos: true: Rotaciona a chave. false: Não rotaciona a chave. Valor padrão: false. Nota Este parâmetro é aplicável apenas a instâncias do ApsaraDB RDS for PostgreSQL.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	O ID da solicitação.	777C4593-8053-427B-99E2-105593277CAB

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "777C4593-8053-427B-99E2-105593277CAB"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	%s	DB Operation Failed:%s.
400	InvalidTDEstatus	Specified TDEStatus has already configed in the This instance.
400	MissingDBName	The request is missing a DBName parameter.
400	InvalidTDEstatus.Format	The Specified TDEStatus is not valid.	O status de Transparent Data Encryption (TDE) especificado é inválido.
400	Invalid.PrivateKey	The requested privateKey parameter is invalid.	O parâmetro de chave privada na solicitação é inválido.
400	Invalid.Certificate	The requested certificate parameter is invalid.	O parâmetro de certificado na solicitação é inválido.
400	CertOrPrivateKeyOrPasswordNotMatched	The public certificate, private key, and password do not match.	A senha da chave privada do certificado não corresponde.
400	InvalidTDEKey	Kms key is disabled.	A chave KMS foi desativada.
400	InvalidTDEStatus.NotFound	The specified TDEStatus does not exist.	O status de TDE especificado não existe.
400	PermissionDenied	The current account has not been authorized to allow RDS to access user's KMS services, authorization needs to be granted to this account.	A conta atual não autorizou o ApsaraDB RDS a acessar o Key Management Service (KMS). Autorize o RDS a acessar o KMS. Para mais informações, consulte a documentação sobre como autorizar o RDS a acessar o KMS.
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.
400	BYOKCertExpired	The certificate has exceeded the validity period.	O certificado expirou.
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	IncorrectDBInstanceType	Current DB instance type does not support this operation.	A operação falhou porque o mecanismo e o tipo da instância de banco de dados atual não são suportados.
403	IncorrectEngineVersion	Current engine version does not support operations.
403	IncorrectDBInstanceLockMode	Current DB instance lock mode does not support this operation.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	A operação falhou. O status atual da instância não suporta esta operação. Tente novamente mais tarde.
403	DBSizeExceeded	Exceeding the allowed DB size of DB instance.	A operação falhou porque o número de instâncias de banco de dados atingiu o limite superior.
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	ByokRoleArnNotFound	The roleArn can not be null.	O parâmetro RoleArn não pode estar vazio.
403	InvalidKmsKey	Kms key is disabled.	A chave KMS especificada está desativada.
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	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	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.
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.	Esta operação não é permitida porque existe uma implantação blue-green.
403	CrossBackupStrategyNotSupport	Cross region backup strategy is not supported.	As políticas de backup entre regiões não são suportadas.
404	InvalidClusterKms	this cluster not kms service.
404	InsufficientResourceCapacity	There is insufficient capacity available for the requested instance.
404	InvalidDBName.NotFound	Specified one or more DB name does not exist or DB status does not support.	O banco de dados não existe. Verifique se o nome do banco de dados está correto.
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.