文档

CheckKMSAuthorized - 检查kms密钥是否已存在

更新时间:

查看用户KMS开通状态。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:CheckKMSAuthorizedRead
  • DBCluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

说明 您可以调用 DescribeRegions 接口查看目标账号下的可用地域信息,包括地域 ID。
cn-hangzhou
DBClusterIdstring

集群 ID。

说明 您可以调用 DescribeDBClusters 接口查看目标地域下所有的集群信息,包括集群 ID。
pc-************
TDERegionstring

TDE 密钥所在地域。

cn-beijing

返回参数

名称类型描述示例值
object
AuthorizationStateinteger

授权状态。取值范围如下:

  • 0:未授权。

  • 1:已授权。

0
RequestIdstring

请求 ID。

A7E6A8FD-C50B-46B2-BA85-D8B8D3******
RoleArnstring

角色的全局资源描述符,用来指定具体角色。详情请参见 RAM 角色概览

acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole
DBClusterIdstring

集群 ID。

pc-************

示例

正常返回示例

JSON格式

{
  "AuthorizationState": 0,
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "RoleArn": "acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole",
  "DBClusterId": "pc-************"
}

错误码

HTTP status code错误码错误信息描述
403UnsupportedKmsService.NotEnabledKMS service is not enabled.未启用KMS服务。
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码:403