適用対象の説明
現在のバージョンでは、スタンバイクラスタでのユーザー作成はサポートされていません。
機能の概要
このAPIは、指定したテナント内にデータベースへアクセスするアカウントを作成します。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers
リクエストパラメータ
Path
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | String | はい | テナントID。 | t4louaeei**** |
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| userName | String | はい | データベースアカウント名。SYSやrootなどの予約語は使用できません。 | pay_test |
| password | String | はい | データベースアカウントのパスワード。
説明大文字英字、小文字英字、数字、特殊文字の3種類を含み、長さは10～32文字である必要があります。特殊文字：!@#$%^&*()_+-= |
!Aliyun4Oceanbase |
| userType | String | はい | データベースアカウントのタイプ。
|
Normal |
| host | String | いいえ | ユーザーのホスト。 | |
| roles | String | いいえ | ユーザーのロール。 | |
| encryptionType | String | いいえ | 暗号化タイプ。 | |
| description | String | いいえ | データベースの説明情報。 | this is a test database |
| 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 | データベースアカウントの状態。
|
ONLINE |
| userType | String | データベースアカウントタイプ。
|
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": "xxxxxx",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}