機能の概要
このAPIは、指定した条件に基づいてOceanBaseクラスタ内のテナントリスト情報を検索するために使用されます。テナント名のあいまい一致とタグによるフィルタリングをサポートし、ページネーション検索も可能です。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants
リクエストパラメータ
Path
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
Query
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
| pageNumber | Integer | いいえ | ページネーション検索のページ番号。
|
1 |
| pageSize | Integer | いいえ | ページネーション検索時の1ページあたりの行数。
|
10 |
| tenantName | String | いいえ | テナント名。 テナント名の検索ではあいまい一致がサポートされます。 |
pay_**** |
| tagList | String | いいえ | タグリスト。 | なし |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data | object | テナント情報。dataListプロパティフィールドを含みます。 | |
| dataList | object[] | テナント情報リスト。プロパティは下記をご参照ください。 | |
| tenantId | String | テナントID。 | t33h8y08k**** |
| tenantName | String | テナント名。 テナント名の検索では、あいまい一致がサポートされます。 |
pay_**** |
| tenantMode | String | テナントモード。現在サポートされているモードは以下のとおりです：
|
Oracle |
| status | String | テナントの状態。
|
ONLINE |
| cpu | Integer | テナントの総CPUコア数。単位：Core。 | 10 |
| mem | Integer | テナントの総メモリサイズ。単位：GiB。 | 20 |
| unitCpu | Integer | テナントの各UnitあたりのCPUコア数。単位：Core。 | 5 |
| unitMem | Integer | テナントの各Unitあたりのメモリサイズ。単位：GiB。 | 10 |
| unitNum | Integer | テナントのUnit数。 | 2 |
| gmtCreate | string | テナント作成日時 | 2021-09-20 12:00:00 |
| primaryZone | string | テナントのプライマリゾーン。クラスタデプロイメントのゾーンの一つです。 | ゾーンH |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants?requestId={requestId}&pageNumber={pageNumber}&pageSize={pageSize}&tenantName={tenantName}&tagList={tagList}' \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDが指定されたプロジェクトIDと一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"data": {
"dataList": [
{
"cpu": 4,
"gmtCreate": "2021-09-20 12:00:00",
"mem": 8,
"primaryZone": "ゾーンH",
"status": "ONLINE",
"tenantId": "abcd123",
"tenantMode": "MySql",
"tenantName": "my_test_tenant",
"unitCpu": 4,
"unitNum": 2,
"unitMem": 8
},
{
"cpu": 4,
"gmtCreate": "2021-09-20 12:00:00",
"mem": 8,
"primaryZone": "ゾーンH",
"status": "PENDING_CREATE",
"tenantId": "dfje0123",
"tenantMode": "Oracle",
"tenantName": "my_test_tenant2",
"unitCpu": 4,
"unitNum": 2,
"unitMem": 8
}
],
"hasMore": true,
"total": 2
},
"requestId": "request-id-uuid",
"server": "xxx.xxx.x.xxx:xxxx"
}