機能の概要
このAPIは、指定されたクラスタ内の指定されたテナント情報を照会し、そのテナント配下のすべての読み取り専用レプリカまたは読み取り専用カラムストアレプリカのリスト情報（レプリカの状態、仕様などを含む）を取得するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}
リクエストパラメータ
Query
名前 |
タイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OB Cloud クラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | ob2mr3oae0**** |
| requestId | String | はい | トレース用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******* |
実行結果
名前 |
タイプ |
説明 |
例値 |
|---|---|---|---|
| data | object | テナント情報。 | |
| tenantId | String | テナントID。 | t33h8y08k**** |
| tenant | Object | テナント情報。 | |
| tenantName | String | テナント名。 | pay_**** |
| description | String | テナントの説明情報。 | paycore 业务数据库 |
| primaryZone | String | テナントのプライマリゾーン。 | cn-hangzhou-i |
| tenantMode | String | テナントモード。 現在サポート：
|
Oracle |
| vpcId | String | 専用ネットワーク(VPC) ID。適切なVPCがない場合は、ページの指示に従ってVPCを作成してください。詳細は「専用ネットワークとは」を参照してください。 | vpc-bp1d2q3mhg9i23ofi**** |
| status | String | テナントの状態。
|
ONLINE |
| cpu | Object | クラスタのCPUリソース情報。 | |
| unitCpu | long | クラスタ内の各レプリカノードのCPU、単位：コア数。 | 10 |
| unitMem | Float | テナントの各Unitのメモリサイズ、単位：GiB。 | 32 |
| unitNum | Integer | テナントのunit数。 | 1 |
| gmtCreate | テナント作成時間 | 2021-09-20 12:00:00 | |
| tenantZones | Array of TenantZones | テナントゾーン情報。
|
ReadWrite |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}?requestId={requestId} \
-H 'X-Ob-Project-Id: <Project ID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {
"deployType": "single",
"description": "my test tenant 1",
"gmtCreate": "2021-10-13 19:59:15.0",
"primaryZone": "cn-wulanchabu-c",
"status": "ONLINE",
"cpu": 4,
"mem": 8,
"unitCpu": 4,
"unitNum": 2,
"unitMem": 8,
"tenantMode": "MySQL",
"tenantName": "t34vln14hlv5s",
"tenantZones": [{
"name": "cn-wulanchabu-c",
"role": "ReadWrite"
}],
"vpcId": "vpc-0jlw84wpoywc2y7ozrtos"
},
"requestId": "a0a16ff1-e8f3-4cf2-83f0-ba58bcd79d18",
"success": true
}