查询一个租户下所有数据库访问的账号列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oceanbase:DescribeTenantUsers | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | string | 是 | 租户 ID。 | ob2mr3oae0**** |
SearchKey | string | 否 | 模糊查询列表的筛选关键字。 | pay |
PageNumber | integer | 否 | 分页查询的页码。 起始值:1,默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时设置的每页行数。 最大值:100,默认值:10。 | 10 |
UserName | string | 否 | 数据库账号名称。 不能使用某些预留关键字,如 SYS、root 等。 | pay_test |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"TenantUsers": [
{
"UserType": "Normal",
"Description": "use for test",
"Databases": [
{
"Database": "db_pay1",
"Role": "ReadOnly",
"Table": "tbl_pay1",
"Privileges": "select,delete,update"
}
],
"UserStatus": "ONLINE",
"UserName": "pay_test",
"TenantId": "t4pnum**** ",
"InstanceId": "obshc32****"
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
2014 | InternalError | The request processing has failed due to some unknown error. | 内部错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-07-04 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-08-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |