DescribeTenantUsers

查詢一個租戶下所有資料庫存取的帳號列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeTenantUsers

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
TenantId	string	是	租戶 ID。	ob2mr3oae0****
SearchKey	string	否	模糊查詢列表的篩選關鍵字。	pay
PageNumber	integer	否	分頁查詢的頁碼。起始值：1，預設值：1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。最大值：100，預設值：10。	10
UserName	string	否	資料庫帳號名稱。不能使用某些預留關鍵字，如 SYS、root 等。	pay_test

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
TotalCount	integer	租戶中的資料庫帳號總數。	1
RequestId	string	請求 ID。	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
TenantUsers	array<object>	租戶中的資料庫帳號列表資訊。
	array<object>	請求的返回結果。
UserType	string	資料庫帳號類型。 Admin：超級帳戶。 Normal：普通帳戶。	Normal
Description	string	資料庫帳號的描述資訊。	use for test
Databases	array<object>	帳號具備的資料庫權限列表資訊。
	object	請求的返回結果。
Database	string	資料庫（schema）名稱	db_pay1
Role	string	擁有的角色。對於 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 有預設的讀寫權限，此處不會列出。	ReadOnly
Table	string	表的名稱。	tbl_pay1
Privileges	string	使用者授予資料庫自訂許可權時，privileges 返回自訂的許可權內容，以逗號 "," 分割；其餘時間 privileges 不返回資料。	select,delete,update
UserStatus	string	資料庫帳號的狀態。 LOCKED：鎖定。 ONLINE：解鎖。	ONLINE
UserName	string	資料庫帳號名稱。	pay_test
TenantId	string	所屬租戶 ID。	t4pnum****
InstanceId	string	所屬叢集 ID。	obshc32****
GlobalPermissions	string	全域權限資訊。	Encrypt,Decrypt

樣本

正常返回樣本

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****",
      "GlobalPermissions": "Encrypt,Decrypt"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
2014	InternalError	The request processing has failed due to some unknown error.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。