Queries the custom keys that are available for an ApsaraDB for Redis instance to use transparent data encryption (TDE).

Note
  • You can specify a custom key when you call the ModifyInstanceTDE operation to enable TDE. You can call the DescribeEncryptionKeyList operation to query the custom keys that are in use. To create a custom key, you can call the CreateKey operation of the Key Management Service (KMS) API.
  • For more information about TDE and the usage notes of TDE, see Enable TDE.

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

Parameter Type Required Example Description
Action String Yes DescribeEncryptionKeyList

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

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the ApsaraDB for Redis instance. You can call the DescribeInstances operation to query instance IDs.

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeInstances operation to query the region IDs of instances.

Response parameters

Parameter Type Example Description
RequestId String 10E2160B-959C-5C3E-BFE6-86EC5925****

The ID of the request.

KeyIds List { "KeyId": [ "a0e7e2c9-8ee5-40ed-bbca-7dbc********", "ad463061-992d-4195-8a94-ed63********" ] }

The custom keys that can be used in the region.

Examples

Sample requests

http(s)://r-kvstore.aliyuncs.com/?Action=DescribeEncryptionKeyList
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format

<DescribeEncryptionKeyListResponse>
      <RequestId>10E2160B-959C-5C3E-BFE6-86EC5925****</RequestId>
      <KeyIds>
            <KeyId>a0e7e2c9-8ee5-40ed-bbca-7dbc********</KeyId>
            <KeyId>ad463061-992d-4195-8a94-ed63********</KeyId>
      </KeyIds>
</DescribeEncryptionKeyListResponse>

JSON format

{
    "RequestId": "10E2160B-959C-5C3E-BFE6-86EC5925****",
    "KeyIds": {
        "KeyId": [
            "a0e7e2c9-8ee5-40ed-bbca-7dbc********",
            "ad463061-992d-4195-8a94-ed63********"
        ]
    }
}

Error codes

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