All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstanceTDE

Last Updated:Jul 05, 2024

Queries the status of the Transparent Data Encryption (TDE) feature for an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxx

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TDEStatusstring

The TDE status of the instance. Valid values:

  • Enabled
  • Disabled
Enabled
RequestIdstring

The ID of the request.

C816A4BF-A6EC-4722-95F9-2055859CCFD2
Databasesarray<object>

The TDE status at the database level.

Note If your instance runs SQL Server 2019 SE or SQL Server EE, you can specify whether to enable TDE at the database level when you enable TDE at the instance level.
object
DBNamestring

The name of the database.

test02
TDEStatusstring

The TDE status at the database level. Valid values:

  • Enabled
  • Disabled
Enabled
TDEModestring

The method that is used to generate the key for TDE at the instance level. Valid values:

  • Aliyun_Generate_Key
  • Customer_Provided_Key
  • Unknown
Aliyun_Generate_Key

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400%sDB Operation Failed:%s.-
400Connect.TimeoutService can not connect to instance temporarily.The operation failed. The RDS instance cannot be connected. Please try again later.
400SqlExcutionFailedFailed to connect to host: connection timed out.The connection to the host timed out.
400DbossGeneralErrorThe instance is being created. Please wait.The RDS instance is being created.
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou 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.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.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear 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.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Cloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
403IncorrectDBInstanceTypeCurrent DB instance engine and type does not support operations.The operation failed. The operation is not supported for the database engine of the RDS instance.
403IncorrectEngineVersionThe engine version does not support the operation.The operation failed. The operation is not supported for the database engine version of the RDS instance.
403DBSizeExceededExceeding the allowed DB size of DB instance.The size of the database exceeds the maximum size that is allowed.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403InvalidVswitchIdSpecified conn vswitch id is not valid.-
404InvalidDBName.NotFoundSpecified one or more DB name does not exist or DB status does not support.The operation failed. The instance name cannot be found.
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-03The Error code has changedView Change Details
2024-05-28The Error code has changedView Change Details
2023-08-31The Error code has changed. The response structure of the API has changedView Change Details
2022-10-28The Error code has changedView Change Details
2022-06-23API Description Update. The Error code has changedView Change Details
2021-10-19The Error code has changedView Change Details