Todos os produtos
Search
Central de documentação

:DescribeDBInstanceTDE

Última atualização: Jun 26, 2026

Consulta o status de criptografia de dados de uma instância.

Esta operação permite visualize a configuração de Transparent Data Encryption (TDE) de uma instância.

O recurso TDE é ativado na instância por meio da operação ModifyDBInstanceTDE.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Parâmetros de requisição

Parameter

Type

Required

Example

Description

Action

String

Yes

DescribeDBInstanceTDE

A operação que você deseja execute. Defina o valor como DescribeDBInstanceTDE.

DBInstanceId

String

Yes

rm-uf6wjk5xxxxxxx

O ID da instância. Chame a operação DescribeDBInstances para consultar o ID da instância.

Parâmetros de resposta

Parameter Type Example Description
TDEStatus String Enabled

O status do TDE no nível da instância. Valores válidos: Enabled e Disabled.

RequestId String C816A4BF-A6EC-4722-95F9-2055859CCFD2

O ID da requisição.

Databases Array of Database

Os detalhes do status do TDE no nível do banco de dados.

Nota Se a instância executa SQL Server 2019 SE ou SQL Server EE, é possível especifique se o TDE será ativado no nível do banco de dados ao ativá-lo no nível da instância.
Database
DBName String test02

O nome do banco de dados.

TDEStatus String Enabled

O status do TDE no nível do banco de dados. Valores válidos: Enabled e Disabled.

Exemplos

Exemplos de requisição

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceTDE
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Exemplos de resposta bem-sucedida

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeDBInstanceTDEResponse>
	<TDEStatus>Enabled</TDEStatus>
	<Databases>
		<DBName>test02</DBName>
		<TDEStatus>Enabled</TDEStatus>
	</Databases>
	<requestId>C816A4BF-A6EC-4722-95F9-2055859CCFD2</requestId>
</DescribeDBInstanceTDEResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TDEStatus" : "Enabled",
  "Databases" : [ {
    "DBName" : "test02",
    "TDEStatus" : "Enabled"
  } ],
  "requestId" : "C816A4BF-A6EC-4722-95F9-2055859CCFD2"
}

Códigos de erro

HTTP status code

Error code

Error message

Description

400

Connect.Timeout

Service can not connect to instance temporarily.

Erro retornado porque não foi possível conectar à instância. Tente novamente mais tarde.

400

SqlExcutionFailed

Failed to connect to host: connection timed out.

Erro retornado porque a conexão com o host atingiu o tempo limite.

400

DbossGeneralError

The instance is being created. Please wait.

Erro retornado porque a instância está sendo criada.

403

IncorrectDBInstanceType

Current DB instance engine and type does not support operations.

Erro retornado porque a operação não é compatível com o mecanismo de banco de dados da instância.

403

IncorrectEngineVersion

The engine version does not support the operation.

Erro retornado porque esta operação não é compatível com a versão do mecanismo de banco de dados em execução na instância.

403

DBSizeExceeded

Exceeding the allowed DB size of DB instance.

Erro retornado porque o tamanho do banco de dados especificado excede o limite máximo permitido.

404

InvalidDBName.NotFound

Specified one or more DB name does not exist or DB status does not support.

Erro retornado porque o nome da instância não foi encontrado.

Para obter a lista de códigos de erro, acesse o API Error Center.