機能の概要
このAPIは、指定されたOceanBaseクラスタのテナント下にあるデータベースリストを照会するために使用されます。データベース名でのフィルタリングとページネーションクエリをサポートしています。実行結果には、データベースの名前、文字セット、状態、作成日時、権限を持つユーザーリストなどの情報が含まれます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/databases
リクエストパラメータ
パスパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
クエリパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| databaseName | string | いいえ | データベース名。クエリ結果のフィルタリングに使用されます。 | test_db |
| pageNumber | integer | いいえ | ページ番号。 | 1 |
| pageSize | integer | いいえ | ページサイズ。 | 20 |
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
実行結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | データベース情報。dataListプロパティフィールドを含みます。 | |
| dataList | object[] | データベース情報リスト。プロパティは下記を参照してください。 | |
| databaseName | string | データベース名。 | databasetest |
| description | string | データベースの説明情報。 | 1**** |
| encoding | string | データベースのエンコーディング。現在、utf8mb4とgbkエンコーディングをサポートしています。 | utf8mb4 |
| gmtCreate | string | 作成日時。 | 2023-08-29T03:43:52Z |
| status | string | データベースの状態。
|
ONLINE |
| tenantId | string | テナントID。 | t50qhutdr**** |
| users | object[] | このデータベースに権限を付与されたアカウントのリスト情報。 | |
| users.role | string | このデータベースに対してアカウントに付与されたロール権限。OceanBase MySQLモードでは、ロールはデータベース（Database）レベルであり、以下の種類があります：
|
ReadWrite |
| users.userName | string | アカウント名。 | test2 |
| users.userType | string | アカウントタイプ。
|
Normal |
例
リクエスト例
curl --request GET \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/databases?databaseName={databaseName}&pageNumber={pageNumber}&pageSize={pageSize}&requestId={requestId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data":{
"dataList":[
{
"databaseName":"databasetest",
"description":"123456",
"encoding":"utf8mb4",
"gmtCreate":"2023-08-29T03:43:52Z",
"status":"ONLINE",
"tenantId":"t50qhutdrc5gg",
"users":[
{
"role":"readwrite",
"userName":"test2",
"userType":"Normal"
}
]
}
],
"total":1
},
"requestId":"ded0298e-e422-4e29-ada9-85952a8342cc",
"success":true
}