查询实例的自定义密钥列表。
接口说明
使用通过 DescribeUserEncryptionKeyList 查询到的自定义密钥可以开启透明数据加密 TDE。详细信息请参见 ModifyDBInstanceTDE 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
dds:DescribeUserEncryptionKeyList |
get |
*dbinstance
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
DBInstanceId |
string |
是 |
实例 ID。 |
dds-bpxxxxxxxx |
TargetRegionId |
string |
否 |
目标可用区 ID,您可以通过 DescribeRegions 查询可用的可用区。 |
cn-shanghai |
RoleARN |
string |
否 |
指定角色的 ARN。格式: 说明
|
acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
RequestId |
string |
请求 ID。 |
7CD51DA4-A499-43CE-B9B5-20CD4FDC648E |
KeyIds |
object |
||
KeyId |
array |
实例密钥列表。 |
|
string |
实例密钥。 |
2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
示例
正常返回示例
JSON
格式
{
"RequestId": "7CD51DA4-A499-43CE-B9B5-20CD4FDC648E",
"KeyIds": {
"KeyId": [
"2a4f4ac2-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
]
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
403 | INVALID_INSNAME_REGIONID_EMPTY | The insName and regionId can't be all empty |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。