CreateTenantUser - 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:CreateTenantUser

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	OceanBase クラスターの ID。	ob317v4uif****
TenantId	string	必須	テナント ID。	t4pnum****
UserName	string	必須	データベースアカウントの名前。 SYS やルートなどの特定の予約キーワードは使用できません。	pay_test
UserType	string	必須	ユーザーのタイプ。有効な値: Normal: 法線アカウント。 Admin: スーパーユーザアカウント。 ReadonlyAccount: 読み取り専用アカウント。MySQL テナントのみが読み取り専用アカウントをサポートしています。	Normal
UserPassword	string	必須	データベースアカウントのパスワード。説明パスワードには、大文字、小文字、数字、特殊文字のうち少なくとも 3 種類の文字タイプを含める必要があります。パスワードは 10～32 文字の長さである必要があります。特殊文字には !@#$%^*()_+-= が含まれます。	!Aliyun4Oceanbase
Roles	string	任意	ユーザーのロール情報。標準ユーザーの場合、アカウント情報を JSON 形式の文字列として指定します。値はデータベース (MySQL パターン) 情報とロール情報 (Role) を含む配列です。ロールには次のタイプがあります: 読み取りおよび書き込み権限 (ReadWrite): ALL PRIVILEGES。読み取り専用権限 (ReadOnly): SELECT。 DDL 権限 (DDL): CREATE, DROP, ALTER, SHOW VIEW, CREATE VIEW。 DML 権限: SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。 DML 権限 (DML): SELECT, INSERT, UPDATE, DELETE, SHOW VIEW。説明 Oracle パターン: このパラメーターは空のままにします。 MySQL パターン: スーパーユーザアカウントにはデフォルトで ALL PRIVILEGES が付与されます。このパラメーターは空のままにします。。	[{"Database":"oceanbase1","Role":"readwrite"},{"Database":"oceanbase2","Role":"readonly"}]
Description	string	任意	データベースの説明。	this is a test database
EncryptionType	string	任意	暗号化メソッド。	RAS
GlobalPermissions	string	任意	グローバル権限情報。	Encrypt,Decrypt

リクエストエンドポイントのリストについては、API リファレンス > 呼び出し方法を参照してください。

レスポンスフィールド

フィールド	型	説明	例
	object	応答パラメーター。
RequestId	string	リクエスト ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
TenantUser	object	テナント内のデータベースアカウントのリスト。
UserType	string	ユーザーのタイプ。有効な値: Normal: 法線アカウント。 Admin: スーパーユーザアカウント。 ReadonlyAccount: 読み取り専用アカウント。MySQL テナントのみが読み取り専用アカウントをサポートしています。	Normal
Roles	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
UserStatus	string	データベースアカウントのステータス。有効な値: LOCKED: ロック済み。 ONLINE: ロック解除済み。説明新しく作成されたアカウントのデフォルトステータスは ONLINE です。	ONLINE
UserName	string	データベースアカウントの名前。	pay_test
GlobalPermissions	string	グローバル権限。	Encrypt,Decrypt

例

成功レスポンス

JSONJSON

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "TenantUser": {
    "UserType": "Normal",
    "Roles": [
      {
        "Database": "db_pay1",
        "Role": "ReadOnly"
      }
    ],
    "UserStatus": "ONLINE",
    "UserName": "pay_test",
    "GlobalPermissions": "Encrypt,Decrypt"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	InternalError	The request processing has failed due to some unknown error.

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

変更履歴

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