All Products
Search

This Product

    ApsaraDB RDS:DescribeDBInstanceTDE

    Document Center

    ApsaraDB RDS:DescribeDBInstanceTDE

    Last Updated:Sep 26, 2023

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

    Operation Description

    Supported database engines

    • RDS MySQL
    • RDS PostgreSQL
    • RDS SQL Server

    debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    debugging

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:DescribeDBInstanceTDEREAD
    • DBInstance
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

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

    		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
    Databasesobject []

    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.
    DBNamestring

    The name of the database.

    		test02
    TDEStatusstring

    The TDE status at the database level. Valid values:

    • Enabled
    • Disabled
    		Enabled
    TDEModestring

    The key method for instance level TDE encryption, with 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
    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.
    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.
    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.

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

    Change history

    Change timeSummary of changesOperation
    2023-08-31The error codes of the API operation change.,The response structure of the API operation changes.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
    Output ParametersThe response structure of the API operation changes.
    2022-10-28The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      Added Error Codes: 403
      Added Error Codes: 404
    2022-06-23API Description Update,The error codes of the API operation change.see changesets
    Change itemChange content
    API DescriptionAPI Description Update
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
    2021-10-19The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change