指定されたクラスター内の指定されたテナントに関する情報を表示します。
今すぐお試しください
テスト
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 |
クラスターデプロイメントタイプ。
|
multiple |
| DeployMode |
string |
テナントのデータレプリカモード。
説明
|
FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j |
| Description |
string |
テナントの説明。 |
paycore 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：サービス中。 |
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 |
テナントのプライマリゾーンのデプロイメントモード。 列挙値:
|
STATIC |
| MasterIntranetAddressZone |
string |
Master ノードが配置されているゾーン。 |
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 |
Binlog サービスをリクエストできるかどうかを示します。 |
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
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。