DescribeTenantEncryption - 查询租户加密信息_云数据库 OceanBase 版(OceanBase)-阿里云帮助中心

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeTenantEncryption	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	否	租户 ID。	t4louaeei****
TenantName	string	否	租户名称。长度为 2~20 个字符，支持英文字母、数字和下划线，区分大小写，必须以字母或下划线开头。不可设置为 sys。	forMySQLTenant
PageNumber	long	否	分页查询的页码。起始值：1 默认值：1	1
PageSize	long	否	每页显示条数，默认为 10。	10

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TotalCount	integer	总数，分页查询时生效。	8
TenantEncryptions	array<object>	允许加密的场景列表信息。
TenantEncryptions	object	允许加密的场景列表。
TenantId	string	租户 ID。	t4louaeei****
TenantMode	string	租户模式。当前支持： Oracle：Oracle 模式。 MySQL: MySQL 模式。	MySQL
TenantName	string	租户名称。	forMySQLTenant
EnableEncryption	boolean	是否启用加密。取值： true false	false
TenantStatus	string	租户状态。	ONLINE
Status	string	租户是否开启加密的状态。	OPEN
EncryptionType	string	加密的类型。	INTERNAL
EncryptionKeyId	string	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	错误码	错误信息	描述
500	InternalError	The request processing has failed due to some unknown error.	内部错误

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史