全部产品
Search

搜索本产品

    云数据库 Tair（兼容 Redis®）：CheckCloudResourceAuthorized - 查询是否已授权KMS密钥

    文档中心

    云数据库 Tair（兼容 Redis®）：CheckCloudResourceAuthorized - 查询是否已授权KMS密钥

    更新时间：Aug 28, 2026

    查询云数据库 Tair（兼容 Redis）实例是否已被授权使用KMS密钥服务。

    接口说明

    • 关于透明数据加密 TDE（Transparent Data Encryption）的详细介绍及注意事项，请参见开启透明数据加密 TDE。

    • 调用本接口确认已授权后，您可以调用 ModifyInstanceTDE 接口开启 TDE 加密功能。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    kvstore:CheckCloudResourceAuthorized

    get

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    InstanceId

    string

    是

    实例 ID，可调用 DescribeInstances 获取。

    r-bp1zxszhcgatnx****
    RoleArn

    string

    否

    指定待授权角色的全局资源描述符 ARN（Alibaba Cloud Resource Name）信息，完成该角色的授权后即可使用相关密钥管理服务，格式：acs:ram::$accountID:role/$roleName 。

    说明

    • $accountID：云账号 ID。您可以登录阿里云控制台，将鼠标悬停在右上角头像的位置，单击安全设置进行查看。

    • $roleName：RAM 角色名称，取值固定为：AliyunRdsInstanceEncryptionDefaultRole。

    acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

    返回参数

    名称

    类型

    描述

    示例值

    object

    AuthorizationState

    integer

    授权状态，返回值：

    • 0：未授权。

    • 1：已授权。

    • 2：未开通密钥管理服务，具体操作，请参见开通密钥管理服务。

    1
    RequestId

    string

    请求 ID。

    A501A191-BD70-5E50-98A9-C2A486A82****

    示例

    正常返回示例

    JSON格式

    {
  "AuthorizationState": 1,
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****"
}

    错误码

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

    变更历史

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