Queries the keys that are used by Transparent Data Encryption (TDE) for a PolarDB-X instance.

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.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeUserEncryptionKeyList

The operation that you want to perform. Set the value to DescribeUserEncryptionKeyList.

DBInstanceNameStringNopxc-hzjasdyu****

The ID of the instance.

RegionIdStringNocn-hangzhou

The region ID of the instance.

Response parameters

ParameterTypeExampleDescription
RequestIdStringFEA5DC20-6D8A-5979-97AA-FC57546ADC20

The ID of the request.

DataObject

The returned data.

KeyIdsArray of StringRkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******

The keys that are used by TDE to encrypt data.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeUserEncryptionKeyList
&DBInstanceName=pxc-hzjasdyu****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<DescribeUserEncryptionKeyListResponse>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
    <Data>
        <KeyIds>RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******</KeyIds>
    </Data>
</DescribeUserEncryptionKeyListResponse>

JSON format

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

{
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Data" : {
    "KeyIds" : [ "RkVBNURDMjAtNkQ4QS01OTc5LTk3QUEtRkM1NzU0Nk******" ]
  }
}

Error codes

HttpCodeError codeError messageDescription
403IncorrectEngineVersionThe current engine version does not support the operation.The error message returned because the engine version of the specified PolarDB-X instance does not support this operation.

For a list of error codes, visit the API Error Center.