DescribeTenantUsers - ApsaraDB for OceanBase (Deprecated) - Alibaba Cloud ドキュメントセンター

テナント配下のデータベースアクセスアカウントのリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oceanbase:DescribeTenantUsers

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
TenantId	string	必須	テナント ID。	ob2mr3oae0****
SearchKey	string	任意	リストクエリ時のあいまい一致用フィルターキーワード。	pay
PageNumber	integer	任意	ページングクエリのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりの行数。最大値: 100。デフォルト値: 10。	10
UserName	string	任意	データベースアカウント名。 SYS やルートなどの特定の予約キーワードは使用できません。	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	データベース（スキーマ）の名前です。	db_pay1
Role	string	アカウントのロールです。 Oracle モードでは、ロールはスキーマレベルロールです。有効な値は次のとおりです。 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 モードでは、ロールはデータベースレベルロールです。有効な値は次のとおりです。 ReadWrite：読み書き権限を持つロールです。ALL PRIVILEGES が含まれます。 ReadOnly：読み取り専用権限 SELECT のみを持つロールです。 DDL：DDL 権限を持つロールです。CREATE、DROP、ALTER、SHOW VIEW、CREATE VIEW が含まれます。 DML：DML 権限を持つロールです。SELECT、INSERT、UPDATE、DELETE、SHOW VIEW が含まれます。説明デフォルトでは、Oracle アカウントは自身のスキーマに対する読み書き権限を持っていますが、ここには表示されません。	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

例

成功レスポンス

JSONJSON

{
  "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 ステータスコード	エラーコード	エラーメッセージ	説明
2014	InternalError	The request processing has failed due to some unknown error.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。