指定されたクラスター内の指定されたテナントの情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
oceanbase:DescribeTenant |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
OceanBase クラスターの ID。 |
ob317v4uif**** |
| TenantId |
string |
必須 |
テナントの ID。 |
t4pnum**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
テナントの詳細情報。 |
||
| RequestId |
string |
リクエスト ID。 |
EE205C00-30E4-****-****-87E3A8A2AA0C |
| Tenant |
object |
テナント情報。 |
|
| TenantId |
string |
テナントの ID。 |
t4louaeei**** |
| TenantName |
string |
テナント名。 |
forMySQLTenant |
| TenantMode |
string |
テナントモード。 |
MySQL |
| VpcId |
string |
非公開仮想クラウド (VPC) の ID。適切な VPC が存在しない場合は、画面の指示に従って作成してください。詳細については、「VPC とは」を参照してください。 |
vpc-bp1d2q3mhg9i23ofi**** |
| Status |
string |
テナントのステータス。有効な値:
|
ONLINE |
| EnableInternetAddressService |
boolean |
テナントでパブリックネットワークアドレスサービスを有効にできるかどうかを示します。 |
true |
| PrimaryZone |
string |
テナントのプライマリゾーン。 |
cn-hangzhou-h |
| DeployType |
string |
クラスターの Deployment タイプ。有効な値:
|
multiple |
| DeployMode |
string |
テナントのデータレプリカモード。高可用性エディションの場合: 3 ゾーン構成では N-N-N、2 ゾーンまたはシングルゾーン構成では N-N。Basic Edition の場合: N。N は単一ゾーン内のノード数を表します。 |
FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j |
| Description |
string |
テナントの説明。 |
payコア database |
| CreateTime |
string |
テナントの作成時間。 |
2023-04-21 11:15:47.0 |
| TenantResource |
object |
テナントのリソース情報。 |
|
| UnitNum |
integer |
テナント内のユニット数。 |
1 |
| Cpu |
object |
テナントの CPU リソース情報。 |
|
| UsedCpu |
number |
テナントで使用されている CPU コア数。単位: コア。 |
8 |
| TotalCpu |
number |
テナントの合計 CPU コア数。単位: コア。 |
10 |
| UnitCpu |
number |
テナントのユニットあたりの CPU コア数。単位: コア。 |
8 |
| Memory |
object |
テナントのメモリリソース情報。 |
|
| UsedMemory |
number |
テナントで使用されているメモリ。単位: GB。 |
30 |
| TotalMemory |
number |
テナントの合計メモリサイズ。単位: GB。 |
64 |
| UnitMemory |
number |
テナントのユニットあたりのメモリサイズ。単位: GB。 |
32 |
| DiskSize |
object |
テナントのディスクリソース情報。 |
|
| UsedDiskSize |
number |
テナントで使用されているディスクサイズ。単位: GB。 |
86 |
| CapacityUnit |
object |
容量単位。 |
|
| MaxCapacityUnit |
integer |
容量単位の最大値。 |
16 |
| MinCapacityUnit |
integer |
容量単位の最小値。 |
1 |
| UsedCapacit |
integer |
使用済みの容量単位。 |
5 |
| LogDiskSize |
object |
テナントのログディスクリソース情報。 |
|
| TotalLogDisk |
integer |
テナントに割り当てられた合計ログディスクサイズ。単位: GB。 |
8.0 |
| UnitLogDisk |
integer |
テナントのユニットあたりに割り当てられたログディスクサイズ。単位: GB。 |
8.0 |
| TenantConnections |
array<object> |
テナントの接続情報。 |
|
|
object |
テナントの接続情報。 |
||
| IntranetAddress |
string |
テナントへのアクセスに使用するプライベートネットワークエンドポイント。 |
t4nunwxr0****.oceanbase.aliyuncs.com |
| IntranetPort |
integer |
テナントへのアクセスに使用するプライベートネットワーク接続ポート。 |
2983 |
| InternetAddress |
string |
テナントへのアクセスに使用するパブリックネットワーク接続アドレス。 |
t4nunwxr0****-mi.oceanbase.aliyuncs.com |
| InternetPort |
integer |
テナントへのアクセスに使用するパブリックネットワーク接続ポート。 |
3306 |
| VpcId |
string |
仮想プライベートクラウド (VPC) の ID。 |
vpc-bp1qiail1asmfe23t**** |
| VSwitchId |
string |
vSwitch の ID。 |
vsw-bp1i7b94u2et716yl**** |
| IntranetAddressMasterZoneId |
string |
テナントへのアクセスに使用するエンドポイントに対応するプライマリゾーン。 |
cn-hangzhou-b |
| IntranetAddressSlaveZoneId |
string |
テナントへのアクセスに使用するエンドポイントに対応するセカンダリゾーン。 |
cn-hangzhou-g |
| IntranetAddressStatus |
string |
テナントへのアクセスに使用するプライベートネットワークエンドポイントのステータス。 |
ONLINE |
| ConnectionZones |
array |
テナント接続に対応するゾーンのリスト。 |
["cn-hangzhou-i", "cn-hangzhou-j"] |
|
string |
テナント接続に対応するゾーン。 |
cn-hangzhou-b |
|
| InternetAddressStatus |
string |
テナントにアクセスするためのパブリックネットワーク接続のステータス。有効な値:
|
CLOSED |
| TransactionSplit |
boolean |
トランザクション分割が有効かどうかを示します。 |
false |
| AddressType |
string |
アドレスタイプ。 有効な値:
列挙値:
|
READONLY |
| EnableTransactionSplit |
boolean |
トランザクション分割が有効かどうかを示します。 |
false |
| ParallelQueryDegree |
integer |
パラレルクエリの次数。 |
1 |
| TenantEndpointId |
string |
テナントのエンドポイント ID。 |
obe-4tw51gp7**** |
| MaxConnectionNum |
integer |
接続数の最大値。 |
5000 |
| ConnectionReplicaType |
string |
接続に対応するレプリカタイプ。 |
FULL |
| ProxyClusterId |
string |
ODP クラスターの ID。 |
proxy-xxxxxxx |
| MaxConnectionLimit |
integer |
プライベートネットワークの接続数の最大値の現在値。 |
1000 |
| InternetMaxConnectionLimit |
integer |
パブリックネットワークの接続数の最大値の上限値。 |
4000 |
| IntranetRpcPort |
integer |
プライベートネットワークのバイパスインポートポート。 |
3307 |
| InternetMaxConnectionNum |
integer |
パブリックネットワークの接続数の最大値の現在値。 |
2500 |
| InternetRpcPort |
integer |
パブリックネットワークのバイパスインポートポート。 |
3307 |
| ConnectionLogicalZones |
array |
アドレスが属する論理ゾーン。 |
|
|
string |
アドレスが属する論理ゾーン情報。 |
cn-bejing-3-z0,cn-bejing-4-z0 |
|
| IntranetSqlPort |
integer |
プライベートネットワークの SQL ポート。 |
3306 |
| OdpVersion |
string |
ODP のバージョン。 |
4.3.1-xxxxxxxxx |
| InternetSqlPort |
integer |
パブリックネットワークの SQL ポート。 |
|
| InternetAddressServiceType |
string |
パブリックネットワークアドレスのサービスタイプ。 |
|
| IntranetAddressServiceType |
string |
プライベートネットワークアドレスのサービスタイプ。 |
|
| TenantZones |
array<object> |
テナントのゾーン情報。 |
|
|
array<object> |
テナントのゾーン情報。 |
||
| TenantZoneId |
string |
テナントゾーンの ID。 |
cn-hangzhou-h |
| Region |
string |
テナントゾーンが属するリージョン。 |
cn-hangzhou |
| TenantZoneRole |
string |
テナントゾーンのロール。 |
ReadWrite |
| TenantZoneReplicas |
array<object> |
テナントゾーンのレプリカ情報。 |
|
|
object |
テナントゾーンのレプリカ情報。 |
||
| ZoneReplicaType |
string |
ゾーンレプリカタイプ。 |
FULL |
| ZoneNodes |
integer |
ゾーンノード。 |
1 |
| LogicZoneName |
string |
論理ゾーン名。 |
cn-shanghai-f-z0 |
| ZoneCopyId |
integer |
ゾーンレプリカの ID。 |
2 |
| FullCopyId |
integer |
フル機能レプリカの ID。 |
3 |
| ReadOnlyCopyId |
string |
読み取り専用レプリカの ID。 |
3 |
| ReadOnlyReplicaType |
string |
読み取り専用レプリカタイプ。 |
ROW_STORE |
| ClogServiceStatus |
string |
Clog サービスの有効化ステータス。有効な値:
|
ONLINE |
| EnableClogService |
boolean |
Clog サービスが利用可能かどうかを示します。このサービスを有効にするには、チケットを起票してください。 |
true |
| Charset |
string |
文字セット。 |
gb18030 |
| Collation |
string |
照合順序。 |
gb18030_chinese_ci |
| PrimaryZoneDeployType |
string |
テナントのプライマリゾーンの Deployment タイプ。 列挙値:
|
STATIC |
| MasterIntranetAddressZone |
string |
マスターノードが属するゾーン。 |
cn-hangzhou-h |
| PayType |
string |
課金方法。 |
POSTPAY |
| InstanceType |
string |
インスタンスタイプ。 |
KAFKA_PUBLIC |
| Series |
string |
インスタンスエディション。 |
normal |
| DiskType |
string |
ディスクタイプ。 |
cloud_essd_pl1 |
| AvailableZones |
array |
ゾーンのリスト。 |
|
|
string |
ゾーンのリスト。 |
["cn-hangzhou-i"] |
|
| EnableReadWriteSplit |
boolean |
読み書き分割アドレスを有効にできるかどうかを示します。 |
true |
| EnableParallelQuery |
boolean |
パラレルクエリを有効にできるかどうかを示します。 |
true |
| MaxParallelQueryDegree |
integer |
並列次数セットの上限値。 |
32 |
| EnableBinlogService |
boolean |
バイナリログサービスをリクエストできるかどうかを示します。 |
true |
| TimeZone |
string |
時間ゾーン。 |
Asia/Shanghai |
| DataMergeTime |
string |
テナントのマージ時間。このパラメーターは OceanBase V4.0.0 以降でのみサポートされています。 |
02:36Z |
| ReadOnlyResource |
object |
読み取り専用リソース情報。 |
|
| UnitNum |
integer |
テナント内のユニット数。 |
2 |
| Cpu |
object |
クラスター内の各レプリカノードの CPU。単位: コア。 |
|
| UsedCpu |
number |
クラスターの使用済み CPU。単位: コア。 |
8 |
| TotalCpu |
number |
テナントの合計 CPU コア数。単位: コア。 |
10 |
| UnitCpu |
number |
テナントのユニットあたりの CPU コア数。単位: コア。 |
8 |
| Memory |
object |
クラスターのメモリ情報。 |
|
| UsedMemory |
number |
テナントで使用されているメモリ。単位: GB。 |
30 |
| TotalMemory |
number |
テナントの合計メモリサイズ。単位: GB。 |
64 |
| UnitMemory |
number |
テナントの各ユニットのメモリサイズ。単位: GB。 |
32 |
| DiskSize |
object |
データディスクサイズの仕様。 |
|
| UsedDiskSize |
number |
テナントで使用されているディスクサイズ。単位: GB。 |
86 |
| CapacityUnit |
object |
容量単位情報。 |
|
| MaxCapacityUnit |
integer |
容量単位の最大値。 |
16 |
| MinCapacityUnit |
integer |
容量単位の最小値。 |
1 |
| UsedCapacit |
integer |
使用済みの容量単位。 |
5 |
| LogDiskSize |
object |
ログディスクサイズ情報。 |
|
| TotalLogDisk |
integer |
ログディスクの合計サイズ。単位: GB。 |
8.0 |
| UnitLogDisk |
integer |
ログディスクのユニット。 |
8.0 |
| EnableReadOnlyReplica |
boolean |
読み取り専用レプリカがサポートされているかどうかを示します。 |
true |
| RecycleBinStatus |
string |
テナントのゴミ箱ステータス。ON は有効、OFF は無効を示します。 |
ON |
| LowerCaseTableNames |
integer |
テーブル名が大文字と小文字を区別するかどうかを示します。有効な値: |
1 |
| Version |
string |
バージョン情報。 |
4.2.1 |
| OdpVersion |
string |
ODP のバージョン。 |
4.3.1-xxxxxxxxx |
| TenantMaxConnections |
integer |
テナントで許可される接続数の最大値。 |
1600 |
| ParameterTemplate |
string |
パラメータテンプレート。 |
express_oltp |
| Iops |
integer |
テナントの IOPS。 |
10000 |
例
成功レスポンス
JSONJSON
{
"RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
"Tenant": {
"TenantId": "t4louaeei****",
"TenantName": "forMySQLTenant",
"TenantMode": "MySQL",
"VpcId": "vpc-bp1d2q3mhg9i23ofi****",
"Status": "ONLINE",
"EnableInternetAddressService": true,
"PrimaryZone": "cn-hangzhou-h",
"DeployType": "multiple",
"DeployMode": "FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j",
"Description": "paycore database",
"CreateTime": "2023-04-21 11:15:47.0",
"TenantResource": {
"UnitNum": 1,
"Cpu": {
"UsedCpu": 8,
"TotalCpu": 10,
"UnitCpu": 8
},
"Memory": {
"UsedMemory": 30,
"TotalMemory": 64,
"UnitMemory": 32
},
"DiskSize": {
"UsedDiskSize": 86
},
"CapacityUnit": {
"MaxCapacityUnit": 16,
"MinCapacityUnit": 1,
"UsedCapacit": 5
},
"LogDiskSize": {
"TotalLogDisk": 8,
"UnitLogDisk": 8
}
},
"TenantConnections": [
{
"IntranetAddress": "t4nunwxr0****.oceanbase.aliyuncs.com",
"IntranetPort": 2983,
"InternetAddress": "t4nunwxr0****-mi.oceanbase.aliyuncs.com",
"InternetPort": 3306,
"VpcId": "vpc-bp1qiail1asmfe23t****",
"VSwitchId": "vsw-bp1i7b94u2et716yl****",
"IntranetAddressMasterZoneId": "cn-hangzhou-b",
"IntranetAddressSlaveZoneId": "cn-hangzhou-g",
"IntranetAddressStatus": "ONLINE",
"ConnectionZones": [
"cn-hangzhou-b"
],
"InternetAddressStatus": "CLOSED",
"TransactionSplit": false,
"AddressType": "READONLY",
"EnableTransactionSplit": false,
"ParallelQueryDegree": 1,
"TenantEndpointId": "obe-4tw51gp7****",
"MaxConnectionNum": 5000,
"ConnectionReplicaType": "FULL",
"ProxyClusterId": "proxy-xxxxxxx",
"MaxConnectionLimit": 1000,
"InternetMaxConnectionLimit": 4000,
"IntranetRpcPort": 3307,
"InternetMaxConnectionNum": 2500,
"InternetRpcPort": 3307,
"ConnectionLogicalZones": [
"cn-bejing-3-z0,cn-bejing-4-z0"
],
"IntranetSqlPort": 3306,
"OdpVersion": "4.3.1-xxxxxxxxx",
"InternetSqlPort": 0,
"InternetAddressServiceType": "",
"IntranetAddressServiceType": ""
}
],
"TenantZones": [
{
"TenantZoneId": "cn-hangzhou-h",
"Region": "cn-hangzhou",
"TenantZoneRole": "ReadWrite",
"TenantZoneReplicas": [
{
"ZoneReplicaType": "FULL",
"ZoneNodes": 1,
"LogicZoneName": "cn-shanghai-f-z0",
"ZoneCopyId": 2,
"FullCopyId": 3,
"ReadOnlyCopyId": "3",
"ReadOnlyReplicaType": "ROW_STORE"
}
]
}
],
"ClogServiceStatus": "ONLINE",
"EnableClogService": true,
"Charset": "gb18030",
"Collation": "gb18030_chinese_ci",
"PrimaryZoneDeployType": "STATIC",
"MasterIntranetAddressZone": "cn-hangzhou-h",
"PayType": "POSTPAY",
"InstanceType": "KAFKA_PUBLIC",
"Series": "normal",
"DiskType": "cloud_essd_pl1",
"AvailableZones": [
"[\"cn-hangzhou-i\"]"
],
"EnableReadWriteSplit": true,
"EnableParallelQuery": true,
"MaxParallelQueryDegree": 32,
"EnableBinlogService": true,
"TimeZone": "Asia/Shanghai",
"DataMergeTime": "02:36Z",
"ReadOnlyResource": {
"UnitNum": 2,
"Cpu": {
"UsedCpu": 8,
"TotalCpu": 10,
"UnitCpu": 8
},
"Memory": {
"UsedMemory": 30,
"TotalMemory": 64,
"UnitMemory": 32
},
"DiskSize": {
"UsedDiskSize": 86
},
"CapacityUnit": {
"MaxCapacityUnit": 16,
"MinCapacityUnit": 1,
"UsedCapacit": 5
},
"LogDiskSize": {
"TotalLogDisk": 8,
"UnitLogDisk": 8
}
},
"EnableReadOnlyReplica": true,
"RecycleBinStatus": "ON",
"LowerCaseTableNames": 1,
"Version": "4.2.1",
"OdpVersion": "4.3.1-xxxxxxxxx",
"TenantMaxConnections": 1600,
"ParameterTemplate": "express_oltp",
"Iops": 10000
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。