機能説明
このインターフェースは、テナント内のすべてのデータベースアクセスアカウントリストを照会するために使用されます。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers
リクエストパラメータ
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
| userName | string | いいえ | データベースアカウント名。SYSやrootなどの予約語は使用できません。 | pay_test |
| pageNumber | integer | いいえ | ページ番号。 | 1 |
| pageSize | integer | いいえ | ページサイズ。 | 20 |
| searchKey | string | いいえ | リストをフラウド検索するキーワード。 | pay |
| requestId | string | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
戻り結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | テナントアカウント情報。dataListプロパティフィールドを含みます。 | |
| dataList | object[] | テナントアカウント情報リスト。プロパティは下記をご参照ください。 | |
| databases | object[] | アカウントが管理するデータベース情報。 この値は空の場合があり、アカウントが関連するデータベース情報を管理していないことを示します。スーパーユーザーアカウントの場合、databaseは空です。 |
|
| databases.database | string | アカウントが管理するデータベース名。 | default_database |
| databases.role | string | アカウントの権限。Oracleモードでは、ロールはスキーマレベルであり、次のように分類されます。
説明また、Oracleアカウントは自身のスキーマに対してデフォルトの読み書き権限を持ちますが、ここでは列挙しません。 |
ReadOnly |
| databases.userName | String | データベースアカウント名。 | test |
| databases.withGrant | boolean | 権限付与権限の有無:
|
0 |
| description | string | データベースアカウントの説明情報。 | use for test |
| userStatus | String | データベースアカウントの状態:
|
ONLINE |
| userType | String | データベースアカウントタイプ:
|
Normal |
例
リクエスト例
curl -v --location \
--request GET \
--digest -u '<Your AK:SK>' \
-H 'X-Ob-Project-Id: <Project ID>' \
-G \
-d 'requestId={requestId}' \
-d 'userName={userName}' \
-d 'pageNumber={pageNumber}' \
-d 'pageSize={pageSize}' \
-d 'searchKey={searchKey}' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantUsers'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {
"dataList": [
{
"databases": [
{
"database": "default_database",
"role": "readwrite",
"userName": "test",
"withGrant": 0
}
],
"description": "this is description",
"userName": "test",
"userStatus": "ONLINE",
"userType": "Normal"
}
],
"total": 1
},
"requestId": "ff75767c-5010-4ee3-8029-a47d3052ec63",
"server": "xxx.xxx.x.xxx:xxxx",
"success": true
}