DescribeTenantUsers - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query all accounts in a tenant that have access to the database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:DescribeTenantUsers	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The return result of the request.	ob2mr3oae0****
SearchKey	string	No	The return result of the request.	pay
PageNumber	integer	No	The database privileges of the account.	1
PageSize	integer	No	The return result of the request.	10
UserName	string	No	The operation that you want to perform. Set the value to DescribeTenantUsers.	pay_test

Response parameters

Parameter	Type	Description	Example
	object	The name of the database account. You cannot use reserved keywords, such as SYS and root.
TotalCount	integer	The role of the account. In Oracle mode, a role is a schema-level role. Valid values: ReadWrite: a role that has the read and write privileges, including: 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, and DROP PROFILE. ReadOnly: a role that has only the read-only privilege SELECT. In MySQL mode, a role is a database-level role. Valid values: ReadWrite: a role that has the read and write privileges, namely ALL PRIVILEGES. ReadOnly: a role that has only the read-only privilege SELECT. DDL: a role that has the DDL privileges such as CREATE, DROP, ALTER, SHOW VIEW, and CREATE VIEW. DML: a role that has the DML privileges such as SELECT, INSERT, UPDATE, DELETE, and SHOW VIEW. Note By default, an Oracle account has the read and write privileges on its own schema, which are not listed here.	1
RequestId	string	The name of the database account.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantUsers	array<object>	The type of the database account. Valid values: Admin: the super administrator account. NORMAL: a general account.
TenantUsers	object	Example 1
UserType	string		NORMAL
Description	string		use for test

Examples

Sample success responses

JSONformat

{
  "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",
      "TenantId": "tshfs3****",
      "InstanceId": "obshc32****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
2014	InternalError	The request processing has failed due to some unknown error.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-07-04	The Error code has changed. The response structure of the API has changed	View Change Details
2022-08-15	The Error code has changed. The request parameters of the API has changed	View Change Details