機能の概要
このAPIは、指定されたクラスタ内のテナントのアドレス情報を照会するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/address/info
リクエストパラメータ
Path
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID。 | obcluster-***** |
Query
パラメータ |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます。 | d04eabba**** |
| pageNumber | Integer | いいえ | ページ番号。 | 1 |
| pageSize | Integer | いいえ | ページサイズ。 | 10 |
| tenantIds | Array[String] | いいえ | テナントIDのリスト。 | ["t4louaeei****"] |
戻り値
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Object | 業務データ(object) | — |
| 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 | データセット | [{"id": "resource-123456"}] |
| total | Number | データの合計量 | 100.0 |
| hasMore | Boolean | まだデータがあるかどうか | true |
data.dataList[]要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| id | String | リソース識別子。 | resource-123456 |
| 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 | 作成日時(UTC) | 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 | メモリサイズ。 | 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 | デプロイタイプ | multiple |
| description | String | 説明情報。 | Tenant for Business Transactions |
| tenantConnections | Array | テナント接続情報 | [{'addre**** |
| tenantZones | Array | zone情報 | [{'repli**** |
| tenantResource | Object | テナントリソース仕様情報 | — |
| tenantResource.cpu | Object | なし | — |
| tenantResource.memory | Object | なし | — |
| tenantResource.disk | Object | なし | — |
| 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 |
| odpDefaultVersion | String | テナントの接続アドレスを作成する際にデフォルトで設定されるODPバージョン。 | 4.2.1 |
| enableProxyService | Boolean | プロキシサービスを有効にするかどうか | true |
| globalAddressAddable | String | グローバルアドレスを作成できるかどうか。ADDABLE:作成可能、DISABLED:新規作成不可、INVISIBLE:非表示。 | ADDABLE |
| enableStandbyReadWriteSplit | String | プライマリ/スタンバイデータベースの読み書き分離スイッチの状態 | ENABLED |
| instanceZoneReplicas | Array | インスタンスのゾーンレプリカリスト | [{'copyI**** |
| zones | Array | ゾーンリスト、カンマ区切り | — |
| tenantMaxConnections | Integer | テナント最大接続数 | xxxxxx |
| ragClusterDo | Object | RAGクラスタの詳細。 | — |
| ragClusterDo.gmtCreate | String | 作成日時 | 2026-02-25T15:40:43+00:00 |
| ragClusterDo.gmtModified | String | 変更日時 | 2026-02-26T10:40:43+00:00 |
| ragClusterDo.ragClusterId | String | RAGクラスタID | obcluster-***** |
| ragClusterDo.ragClusterArn | String | RAGクラスタARN | acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456 |
| ragClusterDo.instanceId | String | OceanBaseクラスタID | obcluster-***** |
| ragClusterDo.tenantId | String | テナントID | t4louaeei**** |
| ragClusterDo.region | String | リージョン。 | ap-guangzhou |
| ragClusterDo.zone | String | ゾーン。 | cn-hangzhou-i |
| ragClusterDo.version | String | "2.2.52" OBバージョン |
2.2.52 |
| ragClusterDo.cloudProvider | String | リソースまたはデータソースが配置されているクラウドプロバイダー | xxxxxx |
| ragClusterDo.status | String | タスクまたはリソースの現在の状態 | ONLINE |
| ragClusterDo.resourceAccount | String | リソースアカウント | 3 |
| ragClusterDo.uid | String | ユーザーID。 | 20000600**** |
| ragClusterDo.servicePort | String | サービスポート。 | 2881 |
| ragClusterDo.backendServicePort | String | バックエンドサービスポート | 2881 |
| ragClusterDo.serviceDomain | String | サービスアクセスドメイン名 | pay-core.oceanbase.example.com |
| ragClusterDo.serviceAddress | String | サービスアクセスアドレス | 10.0.0.10 |
| ragClusterDo.loadBalanceId | String | ロードバランシングインスタンスID | lb-xxxxx**** |
| ragClusterDo.lbVpcId | String | ロードバランシングが配置されているVPC ID | vpc-xxxx**** |
| ragClusterDo.lbVswId | String | ロードバランシングが配置されているスイッチID | vsw-xxxx**** |
| ragClusterDo.lbMasterZone | String | ロードバランシングのプライマリゾーン | cn-hangzhou-i |
| ragClusterDo.lbSlaveZone | String | ロードバランシングのセカンダリゾーン | cn-hangzhou-i |
| enableRag | Boolean | RAGを有効にするかどうか | false |
| iops | Integer | ストレージの1秒間の読み書き回数指標。 | 1000 |
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 | レプリカリソース仕様情報 | — |
| replicaResource.cpu | Object | なし | — |
| replicaResource.memory | Object | なし | — |
| replicaResource.diskSize | Object | なし | — |
| readOnlyReplicaType | Object | なし | — |
data.dataList[].tagList[]要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| 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プロキシクラスタの情報 | — |
| 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 | アーキテクチャアップグレードフラグ。 | true |
| odpVersion | String | ODPバージョン。 | 4.2.1 |
| readStrategyConfigResponse | Object | テナント接続アドレスの読み取りトラフィックポリシー設定 | — |
| readStrategyConfigResponse.odpVersion | String | ODPバージョン。 | 4.2.1 |
| readStrategyConfigResponse.trafficStrategy | String | トラフィックポリシー | ZONE_FIRST |
| readStrategyConfigResponse.replicaParams | Array | レプリカの選択 | — |
| readStrategyConfigResponse.disasterRecoveryReplicaParams | Array | 災害復旧レプリカ | — |
| 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.dataList[].tenantConnections[].connectionLogicalZones[] 要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| data.dataList[].tenantConnections[].connectionLogicalZones[] | String | 接続アドレスに関連付けられた論理ゾーンのリスト。 | cn-hangzhou-i |
data.dataList[].tenantConnections[].connectionZones[] 要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| data.dataList[].tenantConnections[].connectionZones[] | String | 接続先ゾーン | cn-hangzhou-i |
data.dataList[].tenantConnections[].privateLinkList[] 要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| endpointId | String | エンドポイントID。 | ep-xxxxxx |
| status | String | ステータス。 | CONNECTED |
| 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[] 要素のフィールド
フィールド |
タイプ |
説明 |
例 |
|---|---|---|---|
| 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 | zoneのレプリカ情報 | — |
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 | なし | — |
| unitInfoList | Array | このレプリカに関連付けられたUnitリソースの詳細。 | [{"id": "resource-123456"}] |
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 | この論理ゾーン内のノードリスト。 | [{"id": "resource-123456"}] |
data.dataList[].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 | なし | — |
| nodeResource | Object | なし | — |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/address/info \
-H 'X-Ob-Project-Id: <Project ID>' \
-G -d 'requestId=d04eabba****' -d 'pageNumber=1' -d 'pageSize=10' -d 'tenantIds[]=t4louaeei****'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"dataList": [
{
"id": "resource-123456",
"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,
"vpcId": "vpc-xxxx****",
"deployType": "multiple",
"description": "A tenant used for business transactions.",
"tenantConnections": [
{
"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-*****",
"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-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": [],
"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": [
{
"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": [
{
"status": "ONLINE",
"zone": "cn-hangzhou-i",
"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,
"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": [
{
"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": "xxxxxx"
}
]
}
],
"tenantMaxConnections": 1,
"ragClusterDo": {
"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****",
"servicePort": "2881",
"backendServicePort": "2881",
"serviceDomain": "pay-core.oceanbase.example.com",
"serviceAddress": "xxx.xxx.x.xxx:xxx",
"loadBalanceId": "lb-xxxxx****",
"lbVpcId": "vpc-xxxx****",
"lbVswId": "vsw-xxxx****",
"lbMasterZone": "cn-hangzhou-i",
"lbSlaveZone": "cn-hangzhou-i"
},
"enableRag": false,
"iops": 1000
}
],
"total": 100.0,
"hasMore": true
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}