CreateTenantUser - テナントユーザーの作成|OceanBase Cloud|ドキュメント|分散データベース

CreateTenantUser - テナントユーザーの作成

最終更新日：2026-06-03 10:03:39 更新

適用対象の説明

現在のバージョンでは、スタンバイクラスタでのユーザー作成はサポートされていません。

機能の概要

このAPIは、指定されたテナント内にデータベースへのアクセスアカウントを作成するために使用されます。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。

リクエストパス

POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers

リクエストパラメータ

Query

項目	タイプ	必須	説明	例値
instanceId	String	はい	OceanBaseクラウドデータベースのインスタンスIDです。	ob317v4uif****
tenantId	String	はい	テナントIDです。	ob2mr3oae0****

Path

項目	タイプ	必須	説明	例
instanceId	String	はい	OceanBaseクラスタID。	obcluster-*****
tenantId	String	はい	テナントID。	t4louaeei****

Body

項目	タイプ	必須	説明	例
userName	String	はい	データベースアカウント名。SYSやrootなどの予約語は使用できません。	pay_test
password	String	はい	データベースアカウントのパスワード。説明大文字英字、小文字英字、数字、特殊文字の3種類を含み、長さは10～32文字である必要があります。特殊文字：!@#$%^&*()_+-=	!Aliyun4Oceanbase
userType	String	はい	データベースアカウントのタイプ。 Admin：スーパーアカウント。 Normal：通常アカウント。 ReadonlyAccount：読み取り専用アカウント。	Normal
description	String	いいえ	データベースの説明情報。	this is a test database
roles	String	いいえ	ユーザーのロール。
encryptionType	String	いいえ	暗号化タイプ。
globalPermissions	String	いいえ	グローバル権限。
UID	String	いいえ	ユーザーの一意の識別子。
User_ID	String	いいえ	ユーザーID。
callerType	String	いいえ	呼び出し元のタイプ。
accessKeyId	String	いいえ	アクセスキーID。
securityToken	String	いいえ	セキュリティトークン。
callerUid	String	いいえ	呼び出し元ユーザーID。
callerBid	String	いいえ	呼び出し元ビジネスID。
stsTokenCallerUid	String	いいえ	STSトークン呼び出し元ユーザーID。
stsTokenCallerBid	String	いいえ	STSトークン呼び出し元ビジネスID。
acceptLanguage	String	いいえ	対応言語。
pageNumber	Integer	いいえ	ページ番号。
pageSize	Integer	いいえ	1ページあたりの表示数。
mergedCallerBid	String	いいえ	マージされたビジネスID。

戻り値

項目	タイプ	説明	例
data	object	テナント情報。
userName	String	データベースアカウント名。	test
userStatus	String	データベースアカウントのステータス。 Locked：ロックされています。 ONLINE：ロックが解除されています。作成済みのアカウントはデフォルトでONLINE状態になります。	ONLINE
userType	String	データベースアカウントの種類。 Admin：スーパーアカウント。 Normal：通常アカウント。	Normal

例

リクエスト例

curl -v --request POST \
  --digest -u '<Your AK:SK>' \
  --url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers?requestId={requestId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Ob-Project-Id: <Project ID>' \
  --data '{"userName":"test","userType":"normal","password":"ABCabc123@@","description":"test user"}'

説明

プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。

レスポンス例

JSON 形式

{
  "data": {
    "userName": "test",
    "userStatus": "ONLINE",
    "userType": "normal"
  },
  "requestId": "63d5c6c0-****-****-9feb-8e60b3073e81",
  "success": true,
  "server": "xxx.xxx.x.xxx:xxxx"
}

OceanBase

顧客事例