调用DescribeKmsKeys查询可用于云盘加密的KMS密钥-云数据库 MongoDB 版-阿里云

接口说明

查询到的密钥仅适用于云盘加密。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dds:DescribeKmsKeys

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID，您可以调用 DescribeRegions 查询。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	60EEBD77-227C-5B39-86EA-D89163C5****
KmsKeys	array	KMS 的密钥列表。
	object	KMS 的密钥对象。
KeyAlias	string	密钥别名。	key-shh656820f4mh9qxxxxx alias/test1
KeyId	string	密钥 ID。	37291352-xxxx-xxxx-adbf-fd0630a95583

示例

正常返回示例

JSON格式

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "KmsKeys": [
    {
      "KeyAlias": "key-shh656820f4mh9qxxxxx     alias/test1",
      "KeyId": "37291352-xxxx-xxxx-adbf-fd0630a95583"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息
404	EntityNotExistUser	The User does not exist.
404	EntityNotExistService	The Service mongodb.aliyuncs.com does not exist.
404	NoPermissionService	The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409	EntityAlreadyExistsRole	The Role already exists:AliyunServiceRoleForMongoDB.

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

变更历史

更多信息，参考变更详情。