機能の概要
指定されたOceanBase Cloudデータベースインスタンスに関連付けられたOceanBase Database Proxy（ODP）クラスタの詳細情報を照会します。このAPIは、ODPクラスタの設定、状態、ネットワークアドレス、およびインスタンス内の各テナントとの接続関係などの完全な情報を返し、データベースのプロキシ層の監視と管理に使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/proxies
リクエストパラメータ
Path
名前 |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
名前 |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます。 | d04eabba**** |
戻り値
名前 |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| 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オブジェクトのフィールド
名前 |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| instanceId | String | OceanBaseクラスタID | obcluster-***** |
| proxyClusterForTenantResponseMcList | Array | テナントに関連付けられたODPプロキシクラスタのリスト。 | [{"tenantName": "pay_core", "tenantId": "t4louaeei****"}] |
data.proxyClusterForTenantResponseMcList[]要素のフィールド
名前 |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| tenantName | String | テナント名 | xxxxxx |
| describeTenantConnectionODPForMonitorResponseList | Array | テナントの接続アドレスに関連付けられたODPプロキシ監視情報のリスト。 | [{"tenantName": "pay_core", "tenantId": "t4louaeei****"}] |
data.proxyClusterForTenantResponseMcList[].describeTenantConnectionODPForMonitorResponseList[]要素フィールド
項目 |
タイプ |
説明 |
例 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| userVpcOwnerId | String | ユーザーのVPCが属するアカウントの識別子。 | 20000600**** |
| vSwitchId | String | スイッチ識別子。 | vsw-xxxx**** |
| connectionZones | Array | 接続ゾーン | ["zone-a"] |
| tenantEndpointId | String | マルチクラウドv5で追加されたtenantEndpoint ID | te-xxxxx**** |
| addressId | String | マルチクラウド内のvipサービスグループ名 | 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部構成 | TWO_PART |
| useSSL | Boolean | SSLを有効にするかどうか | false |
| proxyClusterId | String | 専用KubernetesプロキシクラスタID | proxy-12**** |
| proxyClusterInfo | Object | テナントの接続に関連付けられたODPプロキシクラスタ情報 | なし |
| proxyClusterInfo.proxyClusterId | String | ODPプロキシクラスタID。 | proxy-12**** |
| proxyClusterInfo.proxyMode | String | ODPプロキシモード。 | DEDICATED |
| proxyClusterInfo.zone | String | ゾーン。 | zone-a |
| proxyClusterInfo.unitSpec | String | ユニット仕様。 | 2C4G |
| proxyClusterInfo.unitNum | Number | Unit数。 | 1.0 |
| proxyClusterInfo.sharedUnitNumLimit | Integer | Kubernetes共有モードプロキシサービスのUnit数上限 | 3 |
| proxyClusterInfo.exclusiveUnitNumLimit | Integer | Kubernetes専用モードプロキシサービスの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のスケーリング上限(Kubernetes ODPClusterSpec.maxUnitNumから取得) | 3.0 |
| proxyClusterInfo.slaveZone | String | スタンバイノードのゾーン（ODPの商用化に伴い追加。2ゾーンまたは3ゾーンのプライマリ・スタンバイ構成でデプロイされている場合にのみ返されます） | zone-a |
| proxyClusterInfo.nodeDistribution | String | ノード配置（ODPの商用化に伴い追加。deployModeに代わるもの） | zone-a:1,zone-b:1 |
| proxyClusterInfo.nodeCpu | Number | ノード仕様（ODPの商用化に伴い追加。unitSpec * unitNumに代わるもの） | 4.0 |
| proxyClusterInfo.nodeNum | Integer | ノード数（ODPの商用化に伴い追加） | 3 |
| proxyClusterInfo.deploymentArchitecture | String | デプロイ構成（ODPの商用化に伴い追加）。商用化前の既存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 | テナント接続アドレスの読み取りトラフィックのポリシー設定 | なし |
| 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 |
| deleteSingleTunnelAddress | Boolean | Alibaba Cloudのプライベート接続用プライマリエンドポイントを削除できるかどうか | true |
| internetAddress | String | パブリックアドレス | 8.8.8.8 |
| internetPort | Integer | パブリックポート | 2881 |
| internetDomain | String | パブリックアドレス | pay-core-public.oceanbase.example.com |
| internetAddressStatus | String | パブリックアドレスの状態 | ONLINE |
| internetMaxConnectionNum | Integer | パブリックネットワークの最大接続数 | 10000 |
| enableUpdateMaxConnectionNum | Boolean | パブリックネットワークでの最大接続数の変更を許可するかどうか | true |
| internetMaxConnectionNumLimit | Integer | パブリックネットワークの最大接続数の上限 | 20000 |
| internetRpcPort | Integer | パブリックネットワークRPCポート | 2882 |
| internetProxyClusterId | String | パブリックネットワークのプロキシクラスタID | proxy-12**** |
| 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 |
| intranetAddressMasterZoneId | String | プライマリゾーンID | zone-**** |
| intranetAddressSlaveZoneId | String | セカンダリゾーンID | zone-**** |
| intranetProxyClusterId | String | プライベートネットワークのプロキシクラスタID | proxy-12**** |
| privateLinkList | Array | PrivateLinkのリスト情報 | [{"id": "resource-123456"}] |
| 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**** |
| proxyServerList | Array | ノード情報 | [{"id": "resource-123456"}] |
data.proxyClusterForTenantResponseMcList[].describeTenantConnectionODPForMonitorResponseList[].connectionZones[]要素フィールド
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| data.proxyClusterForTenantResponseMcList[].describeTenantConnectionODPForMonitorResponseList[].connectionZones[] | String | 接続ゾーン | なし |
data.proxyClusterForTenantResponseMcList[].describeTenantConnectionODPForMonitorResponseList[].privateLinkList[]要素フィールド
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| privateLinkStatus | String | PrivateLinkの開通状態 | ONLINE |
| privateLinkServiceId | String | PrivateLinkサービス側ID | resource**** |
| privateLinkEndpointId | String | PrivateLinkエンドポイント側ID | resource**** |
| privateLinkEndpointVpcId | String | PrivateLink エンドポイントが属するVPC ID。 | vpc-xxxx**** |
| privateLinkEndpointSubnetId | String | PrivateLinkエンドポイント側サブネットID | resource**** |
| privateLinkServiceAccount | String | PrivateLinkサービスのメインアカウント | 3 |
| privateLinkUserAccount | String | PrivateLinkの許可リストユーザーアカウント | 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.proxyClusterForTenantResponseMcList[].describeTenantConnectionODPForMonitorResponseList[].proxyServerList[]要素フィールド
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| proxyServerId | String | ODPプロキシノードID。 | proxy-12**** |
| proxyServerIp | String | ODPプロキシノードIPアドレス。 | 10.0.0.10 |
| spec | String | スペック情報。 | 2C4G |
| zone | String | ゾーン。 | zone-a |
| version | String | "2.2.52" OBバージョン |
2.2.52 |
| status | String | タスクまたはリソースの現在の状態 | ONLINE |
| servicePort | Integer | サービスポート。 | 2881 |
| diskType | String | "cloud_essd_pl1" | "ephemeral_ssd" ストレージタイプ: ESSDクラウドディスク | ローカルSSDディスク |
cloud_essd |
| diskPl | String | ディスクパフォーマンスレベル。 | 200 |
| diskId | String | ディスク識別子。 | xxxxxx |
| diskSize | String | ディスクサイズ | 200 |
| resources | Array | リソースリスト。 | [{"id": "resource-123456"}] |
例
リクエスト例
curl -X GET \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/proxies?requestId=d04eabba****'
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"instanceId": "obcluster-*****",
"proxyClusterForTenantResponseMcList": [
{
"tenantName": "xxxxxx",
"tenantId": "t4louaeei****",
"describeTenantConnectionODPForMonitorResponseList": [
{
"tenantName": "pay_core",
"tenantId": "t4louaeei****",
"vpcId": "vpc-xxxx****",
"userVpcOwnerId": "20000600****",
"vSwitchId": "vsw-xxxx****",
"connectionZones": [
"zone-a"
],
"tenantEndpointId": "te-xxxxx****",
"addressId": "rs-private-internet-*****",
"addressStatus": "ONLINE",
"serviceType": "PRIVATE",
"addressType": "MASTER",
"networkType": "INTRANET",
"role": "READWRITE",
"userNameFormat": "TWO_PART",
"useSSL": false,
"proxyClusterId": "proxy-12****",
"proxyClusterInfo": {
"proxyClusterId": "proxy-12****",
"proxyMode": "DEDICATED",
"zone": "zone-a",
"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": "zone-a",
"nodeDistribution": "zone-a:1,zone-b: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"
},
"deleteSingleTunnelAddress": true,
"internetAddress": "xxx.xxx.x.xxx:xxx",
"internetPort": 2881,
"internetDomain": "pay-core-public.oceanbase.example.com",
"internetAddressStatus": "ONLINE",
"internetMaxConnectionNum": 10000,
"enableUpdateMaxConnectionNum": true,
"internetMaxConnectionNumLimit": 20000,
"internetRpcPort": 2882,
"internetProxyClusterId": "proxy-12****",
"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,
"intranetAddressMasterZoneId": "zone-****",
"intranetAddressSlaveZoneId": "zone-****",
"intranetProxyClusterId": "proxy-12****",
"privateLinkList": [
{
"id": "resource-123456",
"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****",
"proxyServerList": [
{
"id": "resource-123456",
"proxyServerId": "proxy-12****",
"proxyServerIp": "xxx.xxx.x.xxx:xxx",
"spec": "2C4G",
"zone": "zone-a",
"version": "2.2.52",
"status": "ONLINE",
"servicePort": 2881,
"diskType": "cloud_essd",
"diskPl": "200",
"diskId": "xxxxxx",
"diskSize": "200",
"resources": [
{
"id": "resource-123456"
}
]
}
]
}
]
}
]
},
"cost": 1.0,
"server": "10.0.0.10",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}