该接口用于查询一个租户下所有数据库访问的账号列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeTenantUsers

系统规定参数。

取值:DescribeTenantUsers

TenantId String ob2mr3oae0****

租户 ID。

RegionId String cn-hangzhou

地域 ID。

SearchKey String pay

查询列表的删选关键字。

AddressType String -

xxxx

PageNumber Integer 1

分页查询的页码。

起始值:1,默认值:1。

PageSize Integer 10

分页查询时设置的每页行数。

最大值:100,默认值:10。

UserName String pay_test

数据库账号名称。

不能使用某些预留关键字,如 SYS、root 等。

返回数据

名称 类型 示例值 描述
TotalCount Integer 1

租户中的数据库账号总数。

RequestId String EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

请求 ID。

TenantUsers Array of TenantUsers

租户中的数据库账号信息

UserType String Normal

数据库账号类型。

  • Admin:超级账户。
  • Normal:普通账户。
Description String use for test

数据库账号的描述信息。

Databases Array of Databases

账号具备的数据库权限信息。

Database String db_pay1

数据库(schema)名称

Role String ReadOnly

拥有的角色。

对于 Oracle 模式,角色为 schema 级别,其可分为

  • ReadWrite:读写权限,包括 CREATE TABLE CREATE VIEW CREATE PROCEDURE CREATE SYNONYM CREATE SEQUENCE CREATE TRIGGER CREATE TYPE CREATE SESSION EXECUTE ANY PROCEDURE CREATE ANY OUTLINE ALTER ANY OUTLINE DROP ANY OUTLINE CREATE ANY PROCEDURE ALTER ANY PROCEDURE DROP ANY PROCEDURE CREATE ANY SEQUENCE ALTER ANY SEQUENCE DROP ANY SEQUENCE CREATE ANY TYPE ALTER ANY TYPE DROP ANY TYPE SYSKM CREATE ANY TRIGGER ALTER ANY TRIGGER DROP ANY TRIGGER CREATE PROFILE ALTER PROFILE DROP PROFILE;
  • ReadOnly:只读权限,SELECT

    对于MySQL模式,角色为数据库(Database)级别,其有以下几类:

  • ReadWrite:读写权限,包括 ALL PRIVILEGES;
  • ReadOnly:只读权限,包括 SELECT
  • DDL: DDL 权限,包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW
  • DML: DML 权限,包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。
说明

另外, Oracle 账户对自己的 schema 有默认的读写权限,此处不会列出。

Table String tbl_pay1

表的名称。

UserStatus String Normal

数据库账号的状态。

  • LOCKED:锁定。
  • ONLINE:解锁。
UserName String pay_test

数据库账号名称。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTenantUsers
&TenantId=ob2mr3oae0****
&SearchKey=pay
&PageNumber=1
&PageSize=10
&UserName=pay_test
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTenantUsersResponse>
    <TotalCount>1</TotalCount>
    <RequestId>EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C</RequestId>
    <TenantUsers>
        <UserType>Normal</UserType>
        <Description>use for test</Description>
        <Databases>
            <Database>db_pay1</Database>
            <Role>ReadOnly</Role>
            <Table>tbl_pay1</Table>
        </Databases>
        <UserStatus>Normal</UserStatus>
        <UserName>pay_test</UserName>
    </TenantUsers>
</DescribeTenantUsersResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
    } ],
    "UserStatus" : "Normal",
    "UserName" : "pay_test"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
2014 InternalError The request processing has failed due to some unknown error. 内部错误

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