機能の概要
このAPIは、指定されたクラスタ内の指定されたテナント情報を照会し、そのテナント配下のすべての読み取り専用レプリカまたは読み取り専用カラムストアレプリカのリスト情報（レプリカの状態、仕様など）を取得するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
パラメータ |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | トレース用のリクエストID | d04eabba**** |
戻り値
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | None |
| cost | Number | 所要時間 | 1.0 |
| server | String | サーバーアドレス、通常はOBServerノードのIPアドレス | 10.0.0.10 |
| requestId | String | リクエストID | d04eabba**** |
| totalCount | Number | 総レコード数。 | 100.0 |
| extra | Object | 拡張情報。 | {} |
data オブジェクトのフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| ocpTenantId | Integer | OCP内部テナント識別子。 | xxxxxx |
| tenantName | String | テナント名 | xxxxxx |
| managementMode | String | 管理モード、dbaasまたはmaas | DBAAS |
| gmtCreate | String | 作成日時 | 2026-02-25T15:40:43+00:00 |
| createTime | String | 作成日時、読み取り専用 | 2026-02-25T15:40:43+00:00 |
| tenantMode | String | テナントモード。例：MySQLまたはOracle。 | xxxxxx |
| primaryRegion | String | プライマリリージョン | cn-hangzhou |
| primaryZone | String | プライマリゾーン | cn-hangzhou-i |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| cpu | Integer | プロセッサコア数または仕様情報。 | 4 |
| mem | Integer | 総メモリ容量（GB） | 16 |
| diskSize | Integer | ディスクサイズ | 200 |
| unitCpu | Integer | Unitプロセッサ仕様。 | 2 |
| unitMem | Integer | Unitメモリ仕様。 | 8 |
| unitNum | Integer | Unit数。 | 1 |
| unitDiskSize | Integer | Unitディスクサイズ | 200 |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| deployType | String | デプロイメントタイプ | single |
| description | String | 説明情報。 | Tenant for Business Transactions |
| tenantConnections | Array | テナント接続情報 | [{"addressStatus": "ONLINE", "addressType": "MASTER", "intranetAddress": "10.0.0.10", "intranetPort": 2881, "serviceType": "PRIVATE"}] |
| tenantZones | Array | ゾーン情報 | [{"replicaType": "FULL", "status": "ONLINE", "zone": "cn-hangzhou-i"}] |
| tenantResource | Object | テナントリソース仕様情報 | None |
| tenantResource.cpu | Object | なし | None |
| tenantResource.memory | Object | なし | None |
| tenantResource.disk | Object | なし | None |
| tenantResource.unitNum | Integer | Unit数。 | 1 |
| enableBinlogService | Boolean | binlogサービスの有効化が許可されているかどうか | true |
| readonlyConnectionAddable | String | 読み取り専用アドレスを作成できるかどうか。ADDABLE：作成可能、DISABLED：新規作成不可、INVISIBLE：非表示。 | ADDABLE |
| readwriteConnectionAddable | String | 読み書き分離アドレスを作成できるかどうか。ADDABLE：作成可能、DISABLED：新規作成不可、INVISIBLE：非表示。 | ADDABLE |
| timeZone | String | テナント設定のタイムゾーン | +08:00 |
| charset | String | テナント設定の文字セット | utf8mb4 |
| collation | String | 照合順序。 | utf8mb4_general_ci |
| lowerCaseTableNamesParam | Integer | テナントに設定された、テーブル名の大文字と小文字を区別するかどうか | 1 |
| parameterTemplate | String | パラメータテンプレート | oltp |
| tagList | Array | テナントタグ | [{"tagKey": "env", "tagValue": "prod"}] |
| tenantCompatibilityMode | String | テナントの互換モード。TPクラスタの場合はMySQL/Oracle、KVクラスタの場合はHBase/Tableを返します。 | xxxxxx |
| dataMergeTime | String | テナントメジャーコンパクション時間(4.xクラスタのみ) | 02:00 |
| enableProxyPublicLink | Boolean | パブリックネットワーク接続が有効かどうか | false |
| enableProxyPeeringLink | Boolean | ピアリングアドレスが有効かどうか | false |
| odpDefaultVersion | String | テナントのアドレスを作成する際にデフォルトで設定されるodpVersion | 4.2.1 |
| enableProxyService | Boolean | プロキシサービスを有効にするかどうか | true |
| globalAddressAddable | String | グローバルアドレスを作成できるかどうか。ADDABLE：作成可能、DISABLED：新規作成不可、INVISIBLE：非表示。 | ADDABLE |
| enableStandbyReadWriteSplit | String | プライマリ/スタンバイデータベースの読み書き分離スイッチの状態 | ENABLED |
| instanceZoneReplicas | Array | インスタンスのゾーンレプリカのリスト | [{"copyId": 1, "logicZoneName": "cn-hangzhou-i", "replicaType": "FULL", "zone": "cn-hangzhou-i"}] |
| zones | Array | ゾーンのリスト（カンマ区切り） | None |
| tenantMaxConnections | Integer | テナント最大接続数 | xxxxxx |
| ragCluster | Object | RAGクラスタ情報。 | None |
| ragCluster.gmtCreate | String | 作成日時 | 2026-02-25T15:40:43+00:00 |
| ragCluster.gmtModified | String | 変更日時 | 2026-02-26T10:40:43+00:00 |
| ragCluster.ragClusterId | String | RAGクラスタID | obcluster-***** |
| ragCluster.ragClusterArn | String | RAGクラスタARN | acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456 |
| ragCluster.instanceId | String | OceanBaseクラスタID | obcluster-***** |
| ragCluster.tenantId | String | テナントID | t4louaeei**** |
| ragCluster.region | String | 一部のオブジェクトストレージベンダーでは入力が必要です。例：S3 | ap-guangzhou |
| ragCluster.zone | String | ゾーン。 | cn-hangzhou-i |
| ragCluster.version | String | "2.2.52" OBバージョン |
2.2.52 |
| ragCluster.cloudProvider | String | リソースまたはデータソースが存在するクラウドベンダー | xxxxxx |
| ragCluster.status | String | タスクまたはリソースの現在の状態 | ONLINE |
| ragCluster.resourceAccount | String | リソースアカウント | 3 |
| ragCluster.uid | String | ユーザーID。 | 20000600**** |
| enableRag | Boolean | RAGを有効にするかどうか | false |
| iops | Integer | ストレージの1秒間あたりの読み書き回数の指標。 | 1000 |
| aiFunctionStatus | String | AI機能の状態 | ENABLED |
| privateLinkExisted | Boolean | プライベートリンクが存在するかどうか | true |
| tenantCompatibilityControl | String | テナント互換性制御の設定。 | xxxxxx |
| unitLogDisk | Integer | Unitログディスクの仕様。 | 100 |
| directConnectionAddable | String | ダイレクト接続アドレスを作成できるかどうか。ADDABLE：作成可能、DISABLED：新規作成不可、INVISIBLE：非表示。 | ADDABLE |
| directConnectionAddableReasonType | String | ダイレクト接続アドレスを作成できない理由のタイプ。INSTANCE_LEVEL：インスタンスレベルの理由、TENANT_LEVEL：テナントレベルの理由。作成可能な場合はnullです。 | INSTANCE_LEVEL |
| instanceType | String | インスタンスタイプ | DEDICATE**** |
| tenantType | String | テナントタイプ：TP/KV/AP。フラッグシップ版ではテナント単位で、フラッグシップ版以外ではインスタンスタイプで区別します。 | xxxxxx |
| odpAddressStatus | String | テナントのODP接続の準備状態（テナントレベルのみ）。値：ONLINE / PENDING_CREATE。 意味：「当該テナントに、現在少なくとも1つの利用可能なプライマリエンドポイントがあるかどうか」を表します。フロントエンドでプライマリエンドポイント/プライベートネットワーク接続/ピアリング接続/パブリックネットワーク接続のカードを引き続き「準備中」と表示するかどうかの判定に使用します。テナントがすでにオンラインでも最初のプライマリエンドポイントが作成中の場合に、ユーザーが作成操作を繰り返すことを防ぎます。 判定ルール：
許可リストを配布できるかどうかの判定基準（クラスタレベルの{@code ModifyClusterSecurityIpGroup} / テナントレベルの{@code ModifyTenantSecurityIpGroup}）とは異なります。許可リストの配布にはL1+L2の厳密な判定を行います（すべてのプライマリエンドポイントのserver groupがONLINEで、関連するODPプロキシクラスタもすべてONLINEであることが必要です。いずれかが運用保守状態であれば配布を拒否します）。このフィールドではプロキシクラスタの運用保守状態を考慮せず、すべてのプライマリエンドポイントがONLINEであることも要求しません。 |
ONLINE |
data.instanceZoneReplicas[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| copyId | Integer | レプリカ番号。 | 1 |
| logicZoneName | String | 論理ゾーン名。 | cn-hangzhou-i |
| zone | String | ゾーン。 | cn-hangzhou-i |
| logicalZone | String | 論理ゾーン | ap-beijing-3-ro-z0 |
| replicaType | String | レプリカタイプ。FULL、READONLY、LOGONLYなど。 | FULL |
| zoneRegionName | String | レプリカが存在するリージョン名。 | test-name |
| zoneLogicalId | Integer | レプリカが存在する論理ゾーンID。 | xxxxxx |
| zoneId | String | ゾーンID。 | cn-hangz**** |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| nodeNum | Integer | ノード数 | 3 |
| readonlyInstanceId | String | 読み取り専用インスタンスID | obcluster-*****-ro |
| replicaResource | Object | レプリカリソース仕様情報 | None |
| replicaResource.cpu | Object | プロセッサコア数または仕様情報。 | None |
| replicaResource.cpu.totalCpu | Number | CPU総コア数。 | 4.0 |
| replicaResource.cpu.usedCpu | Number | 使用済みCPUコア数。 | 4.0 |
| replicaResource.cpu.originalTotalCpu | Number | 変更前CPU総コア数。 | 4.0 |
| replicaResource.cpu.unitCpu | Number | Unitプロセッサ仕様。 | 2.0 |
| replicaResource.memory | Object | リソース仕様のメモリ情報 | None |
| replicaResource.memory.totalMemory | Number | メモリ総量。 | 16.0 |
| replicaResource.memory.usedMemory | Number | 使用済みメモリ。 | 16.0 |
| replicaResource.memory.originalTotalMemory | Number | 変更前メモリ総量。 | 16.0 |
| replicaResource.memory.unitMemory | Number | Unitメモリサイズ（GB） | 8.0 |
| replicaResource.memory.hostActualMemory | Number | ホストの実際のメモリ容量（単位：GiB） | 16.0 |
| replicaResource.memory.systemMemory | Number | フラッグシップ版のホストでシステムが使用するメモリ容量（単位：GiB）。= hostActualMemory - totalMemory | 16.0 |
| replicaResource.memory.originalHostActualMemory | Number | 元の仕様に対応するホストの実際のメモリ容量（単位：GiB） | 16.0 |
| replicaResource.diskSize | Object | ディスクサイズ | None |
| replicaResource.diskSize.totalDiskSize | Number | ディスク総容量。 | 200.0 |
| replicaResource.diskSize.usedDiskSize | Number | 使用済みディスク容量。 | 200.0 |
| replicaResource.diskSize.originalTotalDiskSize | Number | 変更前ディスク総容量。 | 200.0 |
| replicaResource.diskSize.totalDataSize | Number | データ総量。 | 200.0 |
| replicaResource.diskSize.unitDiskSize | Number | Unitディスクサイズ | 200.0 |
| replicaResource.diskSize.availableDiskSize | Number | ユーザーが実際に利用できるストレージ容量（単位：GB）。計算式：getAvailableDiskSize(unitDiskSize, nodeCount, obVersion, shareStorageCluster) | 200.0 |
| readOnlyReplicaType | Object | なし | None |
data.tagList[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tagKey | String | タグキー | env |
| tagValue | String | タグ値 | prod |
data.tenantConnections[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| userVpcOwnerId | String | ユーザーのVPCが属するアカウントの識別子。 | 20000600**** |
| vSwitchId | String | スイッチ識別子。 | vsw-xxxx**** |
| connectionZones | Array | 接続ゾーン | ["cn-hangzhou-i"] |
| connectionLogicalZones | Array | 接続アドレスに関連付けられた論理ゾーンのリスト。 | ["cn-hangzhou-i"] |
| connectionReplicaType | String | 接続アドレスを使用してアクセスするレプリカのタイプ。 | FULL |
| tenantEndpointId | String | マルチクラウドv5で追加されたtenantEndpoint ID | te-xxxxx**** |
| addressId | String | マルチクラウドではvip service group nameを指します。 | rs-private-internet-***** |
| addressStatus | String | 接続状態 | ONLINE |
| serviceType | String | アドレスタイプ | PRIVATE |
| addressType | String | アドレスタイプ：MASTER、READONLY | MASTER |
| networkType | String | ネットワークタイプ | INTRANET |
| role | String | 接続タイプ：読み書き/読み取り専用（READWRITE/READONLY）。プライマリエンドポイントでも読み書きタイプの区別が必要な場合があります。スタンバイデータベースのプライマリエンドポイントは読み取り専用です。 | READWRITE |
| userNameFormat | String | このアドレス使用時のユーザー名形式：1部構成、2部構成、3部構成 | TWO_PART |
| useSSL | Boolean | SSLを有効にするかどうか | false |
| proxyClusterInfo | Object | テナント接続に関連付けられたODPプロキシクラスタの情報 | None |
| proxyClusterInfo.proxyClusterId | String | ODPプロキシクラスタID。 | proxy-12**** |
| proxyClusterInfo.proxyMode | String | ODPプロキシモード。 | DEDICATED |
| proxyClusterInfo.zone | String | ゾーン。 | cn-hangzhou-i |
| proxyClusterInfo.unitSpec | String | ユニット仕様。 | 2C4G |
| proxyClusterInfo.unitNum | Number | Unit数。 | 1.0 |
| proxyClusterInfo.sharedUnitNumLimit | Integer | K8S共有モードプロキシサービスのUnit数上限 | 3 |
| proxyClusterInfo.exclusiveUnitNumLimit | Integer | K8S専有モードプロキシサービスのUnit数上限 | 3 |
| proxyClusterInfo.status | String | タスクまたはリソースの現在の状態 | ONLINE |
| proxyClusterInfo.proxyServiceVersion | String | アーキテクチャバージョン | 4.2.1.0 |
| proxyClusterInfo.proxyVersion | String | プロキシバージョン | 4.2.1.0 |
| proxyClusterInfo.createTime | String | 作成時間(UTC) | 2026-02-25T15:40:43+00:00 |
| proxyClusterInfo.expireTime | String | "2020-12-23T04:14:48Z" 期限日 |
2020-12-23T04:14:48+00:00 |
| proxyClusterInfo.deployMode | String | データレプリカモード(n/n-n/n-n-n) | 1-1-1 |
| proxyClusterInfo.maxUnitNum | Number | Serverless ODPのスケーリング上限（K8s ODPClusterSpec.maxUnitNumから取得） | 3.0 |
| proxyClusterInfo.slaveZone | String | スタンバイノードのゾーン（ODPの商用化に伴い追加。2ゾーンまたは3ゾーンのプライマリ/スタンバイ構成でデプロイしている場合にのみ返されます） | cn-hangzhou-i |
| proxyClusterInfo.nodeDistribution | String | ノードの配置（ODPの商用化に伴い追加。deployModeに代わるフィールド） | cn-hangzhou-i:1,cn-hangzhou-j:1 |
| proxyClusterInfo.nodeCpu | Number | ノード仕様（ODPの商用化に伴い追加。unitSpec * unitNumに代わるフィールド） | 4.0 |
| proxyClusterInfo.nodeNum | Integer | ノード数（ODPの商用化に伴い追加） | 3 |
| proxyClusterInfo.deploymentArchitecture | String | デプロイメント方式（ODPの商用化に伴い追加）。{@link com.oceanbase.cloud.infra.common.enums.ProxyDeploymentArchitecture}を参照してください。商用化に未対応の既存ODPクラスタでは、SINGLE_AZ_DEPLOYMENT/DUAL_AZ_DEPLOYMENT/MULTI_AZ_DEPLOYMENTとして表示されます。 | SINGLE_ZONE |
| proxyClusterInfo.proxyServerIds | Array | ODPプロキシノードIDリスト。 | ["resource-123456"] |
| proxyClusterInfo.enableArchitectureUpgrade | Boolean | Architecture Upgradeを有効にするかどうか | true |
| odpVersion | String | ODPバージョン。 | 4.2.1 |
| readStrategyConfigResponse | Object | テナント接続アドレスの読み取りトラフィック戦略設定 | None |
| readStrategyConfigResponse.odpVersion | String | ODPバージョン。 | 4.2.1 |
| readStrategyConfigResponse.trafficStrategy | String | トラフィック戦略 | ZONE_FIRST |
| readStrategyConfigResponse.replicaParams | Array | レプリカの選択 | None |
| readStrategyConfigResponse.disasterRecoveryReplicaParams | Array | 災害復旧レプリカ | None |
| readStrategyConfigResponse.balancedStrategy | String | 負荷分散戦略 | BALANCED |
| readStrategyConfigResponse.disasterRecoveryStrategy | String | 災害復旧戦略、レプリカが利用不可の場合はプライマリレプリカを自動的に照会する | PRIMARY_FIRST |
| addressMasterZoneId | String | アドレスのプライマリゾーン | cn-hangz**** |
| loadBalanceType | String | ロードバランシングタイプ。Alibaba Cloudでのみ設定が必要で、NLBとCLBを区別する | NLB |
| internetAddress | String | パブリックアドレス | 8.8.8.8 |
| internetPort | Integer | パブリックポート | 2881 |
| internetDomain | String | パブリックアドレス | pay-core-public.oceanbase.example.com |
| internetAddressStatus | String | パブリックアドレスの状態 | ONLINE |
| internetMaxConnectionNum | Integer | パブリックの最大接続数 | 10000 |
| internetMaxConnectionNumLimit | Integer | パブリックの最大接続数の上限 | 20000 |
| internetRpcPort | Integer | パブリックRPCポート | 2882 |
| internetProxyClusterId | String | パブリックネットワークのプロキシクラスタID | proxy-12**** |
| internetLoadBalanceType | String | パブリックアドレスのロードバランシングタイプ | NLB |
| intranetAddress | String | プライベートエンドポイント | 10.0.0.10 |
| intranetPort | Integer | プライベートネットワークポート | 2881 |
| intranetDomain | String | プライベートエンドポイント | pay-core-private.oceanbase.example.com |
| intranetAddressStatus | String | プライベートエンドポイントの状態 | ONLINE |
| maxConnectionNum | Integer | プライベートネットワークの最大接続数 | 10000 |
| maxConnectionNumLimit | Integer | プライベートネットワークの最大接続数の変更上限 | 20000 |
| intranetRpcPort | Integer | プライベートネットワークRPCポート | 2882 |
| enableRPc | Boolean | RPCを有効にするかどうか、ダイレクトロード | true |
| disableRpcReason | String | RPCを有効にできない理由 | ODP proxy is not ready |
| intranetAddressMasterZoneId | String | プライマリゾーンID | cn-hangz**** |
| intranetAddressSlaveZoneId | String | セカンダリゾーンID | cn-hangz**** |
| deleteSingleTunnelAddress | Boolean | Alibaba Cloudのプライベートネットワークのプライマリエンドポイントを削除できるかどうか | true |
| intranetProxyClusterId | String | プライベートネットワークのプロキシクラスタID | proxy-12**** |
| forceMigratedObproxyIntranetDeleteInternet | Boolean | 移行されたプライマリエンドポイントにパブリックアドレスが存在する場合、プライベートエンドポイントを削除する際にパブリックアドレスも同時に削除するかどうか | true |
| intranetLoadBalanceType | String | プライベートエンドポイントのロードバランシングタイプ | NLB |
| privateLinkList | Array | プライベートリンクのリスト情報 | [{"endpointId": "ep-xxxxxx", "status": "CONNECTED"}] |
| intranetPeeringAddress | String | ピアリングアドレス | 10.1.0.10 |
| intranetPeeringPort | Integer | ピアリングアドレスポート | 2881 |
| intranetPeeringDomain | String | ピアリングアドレスドメイン名 | pay-core-peering.oceanbase.example.com |
| intranetPeeringAddressStatus | String | ピアリングアドレスの状態 | ONLINE |
| intranetPeeringMaxConnectionNum | Integer | ピアリングアドレスの最大接続数 | 10000 |
| peeringDstVpcId | String | ピアリングアドレスのピアVPC ID | vpc-peer**** |
| peeringDstCidrList | String | ピアリングアドレスのピア側CIDR | 10.1.0.0**** |
| peeringId | String | ピアリング接続ID。 | pcx-xxxx**** |
| intranetPeeringProxyClusterId | String | ピアリングのプライベートエンドポイントのプロキシクラスタID | proxy-12**** |
| intranetRagPort | Integer | プライベートRAGポート | 8080 |
| internetRagPort | Integer | パブリックRAGポート | 8080 |
| internetRagAddress | String | パブリックRAGアドレス | pay-core-rag-public.oceanbase.example.com |
| enableRagHttp | Boolean | RAG HTTPポートを有効にするかどうか | false |
| isVirtualServerGroup | Boolean | 仮想サーバーグループ/プライマリ・スタンバイサーバーグループ（一方が移行） | false |
| isMigrated | Integer | 一方から移行されたクラスタのアドレスかどうか | 0 |
| userFormatConnStatus | String | 1部構成のユーザー名による接続の有効化状態 | ONLINE |
| userFormatConnUnsupportedReason | String | 1部構成のユーザー名によるアクセスの有効化をサポートしていない理由 | 2881 |
data.tenantConnections[].connectionLogicalZones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.tenantConnections[].connectionLogicalZones[] | String | 接続アドレスに関連付けられた論理ゾーンのリスト。 | "cn-hangzhou-i" |
data.tenantConnections[].connectionZones[]要素フィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| data.tenantConnections[].connectionZones[] | String | 接続するゾーン | "cn-hangzhou-i" |
data.tenantConnections[].privateLinkList[]オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| endpointId | String | エンドポイントID。 | ep-xxxxxx |
| status | String | ステータス。 | CONNECTED |
| privateLinkStatus | String | private linkの開通状態 | ONLINE |
| privateLinkServiceId | String | private link service側ID | resource**** |
| privateLinkEndpointId | String | private link endpoint側ID | resource**** |
| privateLinkEndpointVpcId | String | PrivateLink Endpointが所属するVPC ID。 | vpc-xxxx**** |
| privateLinkEndpointSubnetId | String | private link endpoint側サブネットID | resource**** |
| privateLinkServiceAccount | String | private link serviceのメインアカウント | 3 |
| privateLinkUserAccount | String | private linkの許可リストユーザーアカウント | 3 |
| privateLinkDomain | String | プライベートドメイン名 | pay-core.oceanbase.example.com |
| intranetAddress | String | プライベートエンドポイント | 10.0.0.10 |
| intranetDomain | String | プライベートエンドポイント | pay-core-private.oceanbase.example.com |
| deletePrivateLink | Boolean | プライベートネットワークのプライマリエンドポイントを削除できるかどうか（グローバルアドレスに関連付けられている場合は削除できません）。 | true |
data.tenantZones[]オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| status | String | ステータス。 | ONLINE |
| zone | String | ゾーン。 | cn-hangzhou-i |
| name | String | ゾーン名, zoneId | Data Source Name |
| replicaType | String | レプリカタイプ。FULL、READONLY、LOGONLYなど。 | FULL |
| region | String | リージョン。 | ap-guangzhou |
| role | String | 担う役割：読み書き/読み取り専用 | READWRITE |
| tenantZoneReplicas | Array | ゾーンレプリカ情報 | None |
data.tenantZones[].tenantZoneReplicas[]オブジェクトのフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| zoneReplicaType | String | 当該ゾーンにおけるテナントのレプリカタイプ。FULL、READONLY、COLUMNSTOREなど。 | FULL |
| zoneNodes | Integer | このレプリカがカバーするノード数。 | 1 |
| logicZoneName | String | テナントレプリカが配置されている論理ゾーン名。 | cn-hangzhou-i |
| copyId | Integer | テナントトポロジ内のレプリカの順序番号。同一テナント内の異なるレプリカを区別するために使用されます。 | xxxxxx |
| fullCopyId | Integer | フル機能レプリカの表示番号。ページ上の「フル機能レプリカ1」、「フル機能レプリカ2」に対応します。 | xxxxxx |
| readOnlyCopyId | Integer | 読み取り専用レプリカの表示番号。ページ上の「読み取り専用レプリカ1」、「読み取り専用レプリカ2」に対応します。 | xxxxxx |
| tenantZoneRole | String | テナントレプリカが担う役割。読み書きレプリカ、スタンバイレプリカ、読み取り専用レプリカなど。 | cn-hangz**** |
| readOnlyReplicaType | Object | なし | None |
| unitInfoList | Array | このレプリカに関連付けられたUnitリソースの詳細。 | [{"id": "resource-123456"}] |
data.tenantZones[].tenantZoneReplicas[].unitInfoList[]オブジェクトのフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| id | String | 識別子。 | resource-123456 |
| unitId | String | Unit idパラメータ | resource**** |
| serverIp | String | Server ipパラメータ | 10.0.0.10 |
| serverPort | Integer | Serverポート。 | 2881 |
| replicaType | String | レプリカタイプ。FULL、READONLY、LOGONLYなど。 | FULL |
| sn | String | Sn | example-value |
| isPrimary | Boolean | Primary Zoneまたはリーダーレプリカかどうか。 | true |
| cpu | Number | プロセッサコア数または仕様情報。 | 4.0 |
| memory | Number | リソース仕様のメモリ情報 | 16.0 |
| dataSize | Number | データサイズ | 200.0 |
| logDiskSize | Number | ログディスクサイズ | 200.0 |
| zone | String | ゾーン。 | cn-hangzhou-i |
| logicalZone | String | 論理ゾーン | ap-beijing-3-ro-z0 |
| tenantObId | Integer | OceanBaseテナントID。 | xxxxxx |
| tenantId | String | テナントID | t4louaeei**** |
| resourcePoolId | Integer | リソースプール識別子。 | xxxxxx |
| migrateFromServerIp | String | Unit移行元ServerのIPアドレス。 | 10.0.0.11 |
| migrateFromServerPort | Integer | Unit移行元Serverのポート。 | 2881 |
| migrateFromServerSn | String | Unit移行元Serverのシリアル番号。 | server-sn-001 |
| manualMigrate | Integer | Unit移行が手動かどうか。 | 0 |
| enableMigrateUnit | Boolean | Unit移行の開始を許可するかどうか。 | true |
| enableCancelMigrateUnit | Boolean | Unit移行のキャンセルを許可するかどうか。 | true |
| status | String | タスクまたはリソースの現在の状態。 | ONLINE |
data.zones[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| zoneId | String | ゾーンID。 | cn-hangz**** |
| region | String | 一部のオブジェクトストレージベンダーでは必須です。例：S3 | ap-guangzhou |
| zoneDisk | String | 当該ゾーンのデータディスク容量の表示値。 | 200 |
| logicZoneId | String | 論理ゾーンID。 | resource**** |
| replicaType | String | レプリカタイプ。FULL、READONLY、またはLOGONLYなどがあります。 | FULL |
| nodes | Array | 当該論理ゾーンに含まれるノードのリスト。 | [{"id": "resource-123456"}] |
data.zones[].nodes[] オブジェクトフィールド
フィールド |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| id | String | 識別子。 | resource-123456 |
| nodeId | String | ノード識別子。 | xxxxxx |
| serverIp | String | Server IPアドレス | 10.0.0.10 |
| nodeCopyId | Integer | トポロジ内のノードレプリカのソート番号。 | xxxxxx |
| nodeStatus | String | ノードの現在の実行状態。 | ONLINE |
| replicaType | String | ノードが保持するレプリカタイプ。FULL、READONLY、またはLOGONLYなど。 | FULL |
| fullCopyId | Integer | フル機能レプリカの表示番号。 | xxxxxx |
| readOnlyCopyId | Integer | 読み取り専用レプリカの表示番号。 | xxxxxx |
| logicalZone | String | 論理ゾーン | ap-beijing-3-ro-z0 |
| readOnlyReplicaType | Object | なし | None |
| nodeResource | Object | ノードのリソース仕様情報 | None |
| nodeResource.cpu | Object | なし | None |
| nodeResource.memory | Object | なし | None |
| nodeResource.diskSize | Object | なし | None |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
--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形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"tenantId": "t4louaeei****",
"ocpTenantId": 1,
"tenantName": "xxxxxx",
"managementMode": "DBAAS",
"gmtCreate": "2026-02-25T15:40:43+00:00",
"createTime": "2026-02-25T15:40:43+00:00",
"tenantMode": "xxxxxx",
"primaryRegion": "cn-hangzhou",
"primaryZone": "cn-hangzhou-i",
"status": "ONLINE",
"cpu": 4,
"mem": 16,
"diskSize": 200,
"unitCpu": 2,
"unitMem": 8,
"unitNum": 1,
"unitDiskSize": 200,
"unitLogDisk": 100,
"vpcId": "vpc-xxxx****",
"deployType": "single",
"description": "A tenant used for business transactions.",
"tenantConnections": [
{
"addressStatus": "ONLINE",
"addressType": "MASTER",
"intranetAddress": "xxx.xxx.x.xxx:xxx",
"intranetPort": 2881,
"serviceType": "PRIVATE",
"tenantId": "t4louaeei****",
"vpcId": "vpc-xxxx****",
"userVpcOwnerId": "20000600****",
"vSwitchId": "vsw-xxxx****",
"connectionZones": [
"cn-hangzhou-i"
],
"connectionLogicalZones": [
"cn-hangzhou-i"
],
"connectionReplicaType": "FULL",
"tenantEndpointId": "te-xxxxx****",
"addressId": "rs-private-internet-*****",
"networkType": "INTRANET",
"role": "READWRITE",
"userNameFormat": "TWO_PART",
"useSSL": false,
"proxyClusterInfo": {
"proxyClusterId": "proxy-12****",
"proxyMode": "DEDICATED",
"zone": "cn-hangzhou-i",
"unitSpec": "2C4G",
"unitNum": 1.0,
"sharedUnitNumLimit": 3,
"exclusiveUnitNumLimit": 3,
"status": "ONLINE",
"proxyServiceVersion": "4.2.1.0",
"proxyVersion": "4.2.1.0",
"createTime": "2026-02-25T15:40:43+00:00",
"expireTime": "2020-12-23T04:14:48+00:00",
"deployMode": "1-1-1",
"maxUnitNum": 3.0,
"slaveZone": "cn-hangzhou-i",
"nodeDistribution": "cn-hangzhou-i:1,cn-hangzhou-j:1",
"nodeCpu": 4.0,
"nodeNum": 3,
"deploymentArchitecture": "SINGLE_ZONE",
"proxyServerIds": [
"resource-123456"
],
"enableArchitectureUpgrade": true
},
"odpVersion": "4.2.1",
"readStrategyConfigResponse": {
"odpVersion": "4.2.1",
"trafficStrategy": "ZONE_FIRST",
"replicaParams": [
{
"value": "prod",
"weight": 1,
"readOnlyReplicaType": "FULL"
}
],
"disasterRecoveryReplicaParams": [
{
"value": "prod",
"weight": 1,
"readOnlyReplicaType": "FULL"
}
],
"balancedStrategy": "BALANCED",
"disasterRecoveryStrategy": "PRIMARY_FIRST"
},
"addressMasterZoneId": "cn-hangz****",
"loadBalanceType": "NLB",
"internetAddress": "xxx.xxx.x.xxx:xxx",
"internetPort": 2881,
"internetDomain": "pay-core-public.oceanbase.example.com",
"internetAddressStatus": "ONLINE",
"internetMaxConnectionNum": 10000,
"internetMaxConnectionNumLimit": 20000,
"internetRpcPort": 2882,
"internetProxyClusterId": "proxy-12****",
"internetLoadBalanceType": "NLB",
"intranetDomain": "pay-core-private.oceanbase.example.com",
"intranetAddressStatus": "ONLINE",
"maxConnectionNum": 10000,
"maxConnectionNumLimit": 20000,
"intranetRpcPort": 2882,
"enableRPc": true,
"disableRpcReason": "ODP proxy is not ready",
"intranetAddressMasterZoneId": "cn-hangz****",
"intranetAddressSlaveZoneId": "cn-hangz****",
"deleteSingleTunnelAddress": true,
"intranetProxyClusterId": "proxy-12****",
"forceMigratedObproxyIntranetDeleteInternet": true,
"intranetLoadBalanceType": "NLB",
"privateLinkList": [
{
"endpointId": "ep-xxxxxx",
"status": "CONNECTED",
"privateLinkStatus": "ONLINE",
"privateLinkServiceId": "resource****",
"privateLinkEndpointId": "resource****",
"privateLinkEndpointVpcId": "vpc-xxxx****",
"privateLinkEndpointSubnetId": "resource****",
"privateLinkServiceAccount": "3",
"privateLinkUserAccount": "3",
"privateLinkDomain": "pay-core.oceanbase.example.com",
"intranetAddress": "xxx.xxx.x.xxx:xxx",
"intranetDomain": "pay-core-private.oceanbase.example.com",
"deletePrivateLink": true
}
],
"intranetPeeringAddress": "xxx.xxx.x.xxx:xxx",
"intranetPeeringPort": 2881,
"intranetPeeringDomain": "pay-core-peering.oceanbase.example.com",
"intranetPeeringAddressStatus": "ONLINE",
"intranetPeeringMaxConnectionNum": 10000,
"peeringDstVpcId": "vpc-peer****",
"peeringDstCidrList": "10.1.0.0****",
"peeringId": "pcx-xxxx****",
"intranetPeeringProxyClusterId": "proxy-12****",
"intranetRagPort": 8080,
"internetRagPort": 8080,
"internetRagAddress": "pay-core-rag-public.oceanbase.example.com",
"enableRagHttp": false,
"isVirtualServerGroup": false,
"isMigrated": 0,
"userFormatConnStatus": "ONLINE",
"userFormatConnUnsupportedReason": "2881"
}
],
"tenantZones": [
{
"replicaType": "FULL",
"status": "ONLINE",
"zone": "cn-hangzhou-i",
"name": "Data source name",
"region": "ap-guangzhou",
"role": "READWRITE",
"tenantZoneReplicas": [
{
"zoneReplicaType": "FULL",
"zoneNodes": 1,
"logicZoneName": "cn-hangzhou-i",
"copyId": 1,
"fullCopyId": 1,
"readOnlyCopyId": 1,
"tenantZoneRole": "cn-hangz****",
"readOnlyReplicaType": "xxxxxx",
"unitInfoList": [
{
"id": "resource-123456",
"unitId": "resource****",
"serverIp": "xxx.xxx.x.xxx:xxx",
"serverPort": 2881,
"replicaType": "FULL",
"sn": "example-value",
"isPrimary": true,
"cpu": 4.0,
"memory": 16.0,
"dataSize": 200.0,
"logDiskSize": 200.0,
"zone": "cn-hangzhou-i",
"logicalZone": "ap-beijing-3-ro-z0",
"tenantObId": 1,
"tenantId": "t4louaeei****",
"resourcePoolId": 1,
"migrateFromServerIp": "xxx.xxx.x.xxx:xxx",
"migrateFromServerPort": 2881,
"migrateFromServerSn": "server-sn-001",
"manualMigrate": 0,
"enableMigrateUnit": true,
"enableCancelMigrateUnit": true,
"status": "ONLINE"
}
]
}
]
}
],
"tenantResource": {
"cpu": "xxxxxx",
"memory": "xxxxxx",
"disk": "xxxxxx",
"unitNum": 1
},
"enableBinlogService": true,
"readonlyConnectionAddable": "ADDABLE",
"readwriteConnectionAddable": "ADDABLE",
"timeZone": "+08:00",
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"lowerCaseTableNamesParam": 1,
"parameterTemplate": "oltp",
"tagList": [
{
"tagKey": "env",
"tagValue": "prod"
}
],
"tenantCompatibilityMode": "xxxxxx",
"tenantCompatibilityControl": "xxxxxx",
"dataMergeTime": "02:00",
"enableProxyPublicLink": false,
"enableProxyPeeringLink": false,
"odpDefaultVersion": "4.2.1",
"enableProxyService": true,
"globalAddressAddable": "ADDABLE",
"directConnectionAddable": "ADDABLE",
"directConnectionAddableReasonType": "INSTANCE_LEVEL",
"enableStandbyReadWriteSplit": "ENABLED",
"instanceZoneReplicas": [
{
"copyId": 1,
"logicZoneName": "cn-hangzhou-i",
"replicaType": "FULL",
"zone": "cn-hangzhou-i",
"logicalZone": "ap-beijing-3-ro-z0",
"zoneRegionName": "test-name",
"zoneLogicalId": 1,
"zoneId": "cn-hangz****",
"status": "ONLINE",
"nodeNum": 3,
"readonlyInstanceId": "obcluster-*****-ro",
"replicaResource": {
"cpu": {
"totalCpu": 4.0,
"usedCpu": 4.0,
"originalTotalCpu": 4.0,
"unitCpu": 2.0
},
"memory": {
"totalMemory": 16.0,
"usedMemory": 16.0,
"originalTotalMemory": 16.0,
"unitMemory": 8.0,
"hostActualMemory": 16.0,
"systemMemory": 16.0,
"originalHostActualMemory": 16.0
},
"diskSize": {
"totalDiskSize": 200.0,
"usedDiskSize": 200.0,
"originalTotalDiskSize": 200.0,
"totalDataSize": 200.0,
"unitDiskSize": 200.0,
"availableDiskSize": 200.0
}
},
"readOnlyReplicaType": "xxxxxx"
}
],
"zones": [
{
"zoneId": "cn-hangz****",
"region": "ap-guangzhou",
"zoneDisk": "200",
"logicZoneId": "resource****",
"replicaType": "FULL",
"nodes": [
{
"id": "resource-123456",
"nodeId": "xxxxxx",
"serverIp": "xxx.xxx.x.xxx:xxx",
"nodeCopyId": 1,
"nodeStatus": "ONLINE",
"replicaType": "FULL",
"fullCopyId": 1,
"readOnlyCopyId": 1,
"logicalZone": "ap-beijing-3-ro-z0",
"readOnlyReplicaType": "xxxxxx",
"nodeResource": {
"cpu": "xxxxxx",
"memory": "xxxxxx",
"diskSize": "xxxxxx"
}
}
]
}
],
"tenantMaxConnections": 1,
"ragCluster": {
"gmtCreate": "2026-02-25T15:40:43+00:00",
"gmtModified": "2026-02-26T10:40:43+00:00",
"ragClusterId": "obcluster-*****",
"ragClusterArn": "acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456",
"instanceId": "obcluster-*****",
"tenantId": "t4louaeei****",
"region": "ap-guangzhou",
"zone": "cn-hangzhou-i",
"version": "2.2.52",
"cloudProvider": "xxxxxx",
"status": "ONLINE",
"resourceAccount": "3",
"uid": "20000600****"
},
"enableRag": false,
"iops": 1000,
"aiFunctionStatus": "ENABLED",
"privateLinkExisted": true,
"instanceType": "DEDICATE****",
"tenantType": "xxxxxx",
"odpAddressStatus": "ONLINE"
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}