全部产品
Search

搜索本产品

    云数据库 OceanBase：DescribeTenantEncryption - 查询租户加密信息

    文档中心

    云数据库 OceanBase：DescribeTenantEncryption - 查询租户加密信息

    更新时间：Oct 23, 2024

    该接口用于查询租户加密信息。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    InstanceIdstring是

    OceanBase 集群 ID。

    		ob317v4uif****
    TenantIdstring否

    租户 ID。

    		t4louaeei****
    TenantNamestring否

    租户名称。
    长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。 不可设置为 sys。

    		forMySQLTenant
    PageNumberlong否

    分页查询的页码。

    • 起始值：1
    • 默认值：1
    		1
    PageSizelong否

    每页显示条数，默认为 10。

    		10

    返回参数

    名称类型描述示例值
    object

    请求的返回结果。

    RequestIdstring

    请求 ID。

    		EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
    TotalCountinteger

    总数，分页查询时生效。

    		8
    TenantEncryptionsarray<object>

    允许加密的场景列表信息。

    TenantEncryptionsobject

    允许加密的场景列表。

    TenantIdstring

    租户 ID。

    		t4louaeei****
    TenantModestring

    租户模式。
    当前支持：

    • Oracle：Oracle 模式。
    • MySQL: MySQL 模式。
    		MySQL
    TenantNamestring

    租户名称。

    		forMySQLTenant
    EnableEncryptionboolean

    是否启用加密。取值：

    • true
    • false
    		false
    TenantStatusstring

    租户状态。

    		ONLINE
    Statusstring

    租户是否开启加密的状态。

    		OPEN
    EncryptionTypestring

    加密的类型。

    		INTERNAL
    EncryptionKeyIdstring

    kms 加密的 keyId。

    		xxx

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "TotalCount": 8,
  "TenantEncryptions": [
    {
      "TenantId": "t4louaeei****",
      "TenantMode": "MySQL",
      "TenantName": "forMySQLTenant",
      "EnableEncryption": false,
      "TenantStatus": "ONLINE",
      "Status": "OPEN",
      "EncryptionType": "INTERNAL",
      "EncryptionKeyId": "xxx"
    }
  ]
}

    错误码

    HTTP status code错误码错误信息描述
    500InternalErrorThe request processing has failed due to some unknown error.内部错误

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史