DescribeTenants - 条件でテナントを検索する|OceanBase Cloud|ドキュメント|OceanBaseマニュアル

機能の概要

このAPIは、指定された条件に基づいてOceanBase Cloudインスタンス内のテナントリスト情報を照会するために使用されます。テナント名のあいまい一致とタグによるフィルタリングをサポートし、ページネーションクエリも可能です。

呼び出しの説明

インターフェース制約

呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。

リクエストパス

GET /api/v2/instances/{instanceId}/tenants

リクエストパラメータ

Path

パラメータ	タイプ	必須	説明	例
instanceId	String	はい	OceanBaseクラスタID。	obcluster-*****

Query

パラメータ	タイプ	必須	説明	例
requestId	String	はい	追跡用のリクエストID。	dc302d76-66b5-48d8-ab53-a035********
pageNumber	Integer	いいえ	ページネーションクエリのページ番号。初期値：1 デフォルト値：1	1
pageSize	Integer	いいえ	ページネーションクエリ時の1ページあたりの行数。最大値：100。デフォルト値：10。	10
tenantName	String	いいえ	テナント名。テナント名の検索では、あいまい一致がサポートされます。	pay_****
tagList	String	いいえ	タグリスト。	N/A

戻り値

フィールド	タイプ	説明	例
success	Boolean	成功かどうか	true
errorCode	String	エラーコード	INVALID_PARAMETER
errorMessage	String	エラーメッセージ	Invalid parameter
data	Object	業務データ(object)	N/A
cost	Number	所要時間	1.0
server	String	サーバーアドレス、通常はOBServerノードのIPアドレス	10.0.0.10
requestId	String	リクエストID	d04eabba****
totalCount	Number	総レコード数。	100.0
extra	Object	拡張情報。	{}

dataオブジェクトのフィールド

フィールド	タイプ	説明	例
dataList	Array	データセット	[{"tenantId": "t4louaeei****"}]
total	Number	データ総量	100.0
hasMore	Boolean	まだデータがあるかどうか	true

data.dataList[] の要素フィールド

フィールド	タイプ	説明	例
tenantId	String	テナントID	t4louaeei****
ocpTenantId	Integer	OCP内部テナント識別子。	xxxxxx
tenantName	String	テナント名	xxxxxx
managementMode	String	管理モード、dbaasまたはmaas	DBAAS
gmtCreate	String	作成日時	2026-02-25 15:40:43+00:00
createTime	String	作成日時(UTC)	2026-02-25 15: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	ユニットディスクサイズ	200
vpcId	String	VPC識別子。	vpc-xxxx****
deployType	String	デプロイタイプ	multiple
description	String	説明	For tenants used in business transactions.
tenantConnections	Array	テナント接続情報	[{"tenantId": "t4louaeei****"}]
tenantZones	Array	ゾーン情報	[{"name": "Data source name"}]
tenantResource	Object	テナントリソース仕様情報	N/A
tenantResource.cpu	Object	なし	N/A
tenantResource.memory	Object	なし	N/A
tenantResource.disk	Object	なし	N/A
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	peeringアドレスを有効にするかどうか	false
odpDefaultVersion	String	テナントのアドレス作成時にデフォルトで設定されるodpVersion	4.2.1
enableProxyService	Boolean	プロキシサービスを有効にするかどうか	true
globalAddressAddable	String	グローバルアドレスを作成できるかどうか。ADDABLE：作成可能、DISABLED：新規作成不可、INVISIBLE：非表示。	ADDABLE
enableStandbyReadWriteSplit	String	プライマリ/スタンバイデータベースの読み書き分離スイッチの状態	ENABLED
instanceZoneReplicas	Array	インスタンスのゾーンレプリカリスト	[{"logicalZone": "ap-beijing-3-ro-z0"}]
zones	Array	ゾーンリスト（カンマ区切り）	N/A
tenantMaxConnections	Integer	テナント最大接続数	xxxxxx
ragCluster	Object	RAGクラスタ情報。	N/A
ragCluster.gmtCreate	String	作成日時	2026-02-25 15:40:43+00:00
ragCluster.gmtModified	String	変更日時	2026-02-26 10: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つあるかどうかを表します。フロントエンドでプライマリエンドポイント/プライベートネットワーク接続/ピアリング接続/パブリックネットワーク接続のカードがまだ「準備中」かどうかを表示するために使用されます。テナントが既にONLINEであっても、最初のプライマリエンドポイント群がまだ作成中の場合に、ユーザーが作成操作を繰り返すことを防ぎます。判定ルール：当該テナントに属するプライマリエンドポイントのserver group（プライベートネットワーク、パブリックネットワーク、Alibaba Cloud OBPROXYの5種類のプライマリエンドポイントタイプを対象）からDELETEDを除外した結果、集合が空の場合（ODPを作成しないAlibaba Cloud CLBの場合や、作成直後の空のテナントの場合）は、ONLINEを既定値とします。集合に少なくとも1つのONLINEがある場合はONLINEです。後から追加されたパブリックアドレスやピアリングアドレスがPENDING_CREATEであっても、集約結果には影響しません。ODPプロキシクラスタが後から運用保守状態になっても、集約結果には影響しません。すべてのプライマリエンドポイントがONLINE以外の場合（典型例：テナントがONLINEになった直後で、最初のプライマリエンドポイント群がまだ作成中の場合）は、PENDING_CREATEです。許可リストを配布できるかどうかの判定基準（クラスタレベルの{@code ModifyClusterSecurityIpGroup} / テナントレベルの{@code ModifyTenantSecurityIpGroup}）とは異なります。許可リストではL1+L2の厳密な判定（すべてのプライマリエンドポイントのserver groupがONLINEで、かつ関連するODPプロキシクラスタがすべてONLINEである必要があり、いずれかが運用保守状態の場合は配布をブロックする）を行います。一方、このフィールドではプロキシクラスタの運用保守状態を考慮せず、すべてのプライマリエンドポイントがONLINEであることも求めません。	ONLINE

data.dataList[].instanceZoneReplicas[] の要素フィールド

フィールド	タイプ	説明	サンプル値
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	レプリカリソース仕様情報	N/A
replicaResource.cpu	Object	なし	N/A
replicaResource.memory	Object	なし	N/A
replicaResource.diskSize	Object	なし	N/A
readOnlyReplicaType	Object	なし	N/A

フィールド	タイプ	説明	サンプル値
tagKey	String	タグキー	env
tagValue	String	タグ値	prod

data.dataList[].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プロキシクラスタの情報	N/A
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-25 15:40:43+00:00
proxyClusterInfo.expireTime	String	"2020-12-23T04:14:48Z" 有効期限	2020-12-23 04: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****"]
proxyClusterInfo.enableArchitectureUpgrade	Boolean	Architecture Upgradeを有効にするかどうか	true
odpVersion	String	ODPバージョン。	4.2.1
readStrategyConfigResponse	Object	テナント接続アドレスの読み取りトラフィック戦略設定	N/A
readStrategyConfigResponse.odpVersion	String	ODPバージョン。	4.2.1
readStrategyConfigResponse.trafficStrategy	String	トラフィック戦略	ZONE_FIRST
readStrategyConfigResponse.replicaParams	Array	レプリカの選択	N/A
readStrategyConfigResponse.disasterRecoveryReplicaParams	Array	災害復旧レプリカ	N/A
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	プライベートリンクのリスト情報	[{"privateLinkStatus": "ONLINE"}]
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.dataList[].tenantConnections[].connectionLogicalZones[] の要素フィールド

フィールド	タイプ	説明	例
data.dataList[].tenantConnections[].connectionLogicalZones[]	String	接続アドレスに関連付けられた論理ゾーンのリスト。	cn-hangzhou-i

"cn-hangzhou-i" |

data.dataList[].tenantConnections[].connectionZones[] の要素フィールド

フィールド	タイプ	説明	例
data.dataList[].tenantConnections[].connectionZones[]	String	接続先のゾーン	cn-hangzhou-i

"cn-hangzhou-i" |

data.dataList[].tenantConnections[].privateLinkList[] の要素フィールド

フィールド	タイプ	説明	例
privateLinkStatus	String	プライベートリンクの開通状態	ONLINE
privateLinkServiceId	String	プライベートリンクサービス側ID	resource****
privateLinkEndpointId	String	プライベートリンクエンドポイント側ID	resource****
privateLinkEndpointVpcId	String	PrivateLink エンドポイントが属するVPC ID。	vpc-xxxx****
privateLinkEndpointSubnetId	String	プライベートリンクエンドポイント側サブネットID	resource****
privateLinkServiceAccount	String	プライベートリンクサービスのメインアカウント	3
privateLinkUserAccount	String	プライベートリンクの許可リストに登録されたユーザーアカウント	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.dataList[].tenantZones[] の要素フィールド

フィールド	タイプ	説明	例
name	String	ゾーン名、zoneId	Data source name
replicaType	String	レプリカタイプ。例：FULL、READONLY、LOGONLY。	FULL
region	String	リージョン。	ap-guangzhou
role	String	担当するロール。読み書き/読み取り専用	READWRITE
tenantZoneReplicas	Array	ゾーンのレプリカ情報	N/A

data.dataList[].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	なし	N/A
unitInfoList	Array	そのレプリカに関連付けられたUnitリソースの詳細。	[{}]

data.dataList[].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	その論理ゾーン内のノードリスト。	[{"nodeId": "xxxxxx"}]

data.dataList[].zones[].nodes[] の要素フィールド

フィールド	タイプ	説明	例
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	なし	N/A
nodeResource	Object	なし	N/A

例

リクエスト例

curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
  --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,
    "errorCode": "INVALID_PARAMETER",
    "errorMessage": "Invalid parameter",
    "data": {
        "dataList": [
            {
                "tenantId": "t4louaeei****",
                "ocpTenantId": 1,
                "tenantName": "xxxxxx",
                "managementMode": "DBAAS",
                "gmtCreate": "2026-02-25 15:40:43+00:00",
                "createTime": "2026-02-25 15: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,
                "vpcId": "vpc-xxxx****",
                "deployType": "multiple",
                "description": "A tenant for business transactions",
                "tenantConnections": [
                    {
                        "tenantId": "t4louaeei****",
                        "vpcId": "vpc-xxxx****",
                        "userVpcOwnerId": "20000600****",
                        "vSwitchId": "vsw-xxxx****",
                        "connectionZones": "---\n- \"cn-hangzhou-i\"",
                        "connectionLogicalZones": "---\n- \"cn-hangzhou-i\"",
                        "connectionReplicaType": "FULL",
                        "tenantEndpointId": "te-xxxxx****",
                        "addressId": "rs-private-internet-*****",
                        "addressStatus": "ONLINE",
                        "serviceType": "PRIVATE",
                        "addressType": "MASTER",
                        "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-25 15:40:43+00:00",
                            "expireTime": "2020-12-23 04: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": "---\n- \"r****",
                            "enableArchitectureUpgrade": true
                        },
                        "odpVersion": "4.2.1",
                        "readStrategyConfigResponse": {
                            "odpVersion": "4.2.1",
                            "trafficStrategy": "ZONE_FIRST",
                            "replicaParams": [
                                {}
                            ],
                            "disasterRecoveryReplicaParams": [
                                {}
                            ],
                            "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",
                        "intranetAddress": "xxx.xxx.x.xxx:xxx",
                        "intranetPort": 2881,
                        "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": [
                            {
                                "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": [
                    {
                        "name": "Data Source Name",
                        "replicaType": "FULL",
                        "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": [
                                    {}
                                ]
                            }
                        ]
                    }
                ],
                "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",
                "dataMergeTime": "02:00",
                "enableProxyPublicLink": false,
                "enableProxyPeeringLink": false,
                "odpDefaultVersion": "4.2.1",
                "enableProxyService": true,
                "globalAddressAddable": "ADDABLE",
                "enableStandbyReadWriteSplit": "ENABLED",
                "instanceZoneReplicas": [
                    {
                        "logicalZone": "ap-beijing-3-ro-z0",
                        "replicaType": "FULL",
                        "zoneRegionName": "test-name",
                        "zoneLogicalId": 1,
                        "zoneId": "cn-hangz****",
                        "status": "ONLINE",
                        "nodeNum": 3,
                        "readonlyInstanceId": "obcluster-*****-ro",
                        "replicaResource": {
                            "cpu": "xxxxxx",
                            "memory": "xxxxxx",
                            "diskSize": "xxxxxx"
                        },
                        "readOnlyReplicaType": "xxxxxx"
                    }
                ],
                "zones": [
                    {
                        "zoneId": "cn-hangz****",
                        "region": "ap-guangzhou",
                        "zoneDisk": "200",
                        "logicZoneId": "resource****",
                        "replicaType": "FULL",
                        "nodes": [
                            {
                                "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": "xxxxxx"
                            }
                        ]
                    }
                ],
                "tenantMaxConnections": 1,
                "ragCluster": {
                    "gmtCreate": "2026-02-25 15:40:43+00:00",
                    "gmtModified": "2026-02-26 10: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,
                "tenantCompatibilityControl": "xxxxxx",
                "unitLogDisk": 100,
                "directConnectionAddable": "ADDABLE",
                "directConnectionAddableReasonType": "INSTANCE_LEVEL",
                "instanceType": "DEDICATE****",
                "tenantType": "xxxxxx",
                "odpAddressStatus": "ONLINE"
            }
        ],
        "total": 100.0,
        "hasMore": true
    },
    "cost": 1.0,
    "server": "xxx.xxx.x.xxx:xxx",
    "requestId": "d04eabba****",
    "totalCount": 100.0,
    "extra": "{}"
}