调用DescribeUserEncryptionKeyList查询实例的自定义密钥列表。

使用通过DescribeUserEncryptionKeyList查询到的自定义密钥可以开启透明数据加密TDE。详细信息请参见ModifyDBInstanceTDE

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeUserEncryptionKeyList

要执行的操作,取值:DescribeUserEncryptionKeyList

DBInstanceId String dds-bpxxxxxxxx

实例ID。

RegionId String cn-hangzhou

地域ID,您可以调用DescribeRegions查询。

TargetRegionId String cn-hangzhou-h

可用区ID,您可以通过DescribeRegions查询可用的可用区。

返回数据

名称 类型 示例值 描述
KeyIds List 2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx

实例密钥列表。

RequestId String 7CD51DA4-A499-43CE-B9B5-20CD4FDC648E

请求ID。

示例

请求示例

http(s)://mongodb.aliyuncs.com/?Action=DescribeUserEncryptionKeyList
&DBInstanceId=dds-bpxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>7CD51DA4-A499-43CE-B9B5-20CD4FDC648E</RequestId>
<KeyIds>
    <KeyId>2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
    <KeyId>749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx</KeyId>
</KeyIds>

JSON 格式

{
	"RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
	"KeyIds": {
		"KeyId": [
			"2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"578b59ad-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
			"749c1df7-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
		]
	}
}

错误码

访问错误中心查看更多错误码。