機能の概要
このAPIは、指定されたテナントのネットワーク接続アドレスリストを照会します。リストには、プライベートエンドポイントとパブリックアドレスの詳細情報が含まれます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/address
リクエストパラメータ
Path
名称 |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
| tenantId | String | はい | テナントID | t4louaeei**** |
Query
名称 |
タイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | 追跡用リクエストID | d04eabba**** |
| addressId | String | はい | 接続アドレスまたはサービスアドレスの識別子。 | rs-private-internet-***** |
戻り値
名称 |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| success | Boolean | 成功したかどうか | true |
| errorCode | String | エラーコード | INVALID_PARAMETER |
| errorMessage | String | エラーメッセージ | Invalid parameter |
| data | Array | 業務データ。 | なし |
| 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**** |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| userVpcOwnerId | String | ユーザーVPCが属するアカウントの識別子。 | 20000600**** |
| vSwitchId | String | スイッチ識別子。 | vsw-xxxx**** |
| connectionZones | Array | 接続先のゾーン | ["zone-a"] |
| tenantEndpointId | String | テナントエンドポイントID。 | te-xxxxx**** |
| addressId | String | 接続アドレスまたはサービスアドレスの識別子。 | 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 | ODPプロキシクラスタ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 | ユニット数。 | 1.0 |
| proxyClusterInfo.sharedUnitNumLimit | Integer | K8s共有モードプロキシサービスのユニット数上限。 | 3 |
| proxyClusterInfo.exclusiveUnitNumLimit | Integer | K8s専有モードプロキシサービスのユニット数上限。 | 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:48+00:00 |
| proxyClusterInfo.deployMode | String | データレプリカモード(n/n-n/n-n-n) | 1-1-1 |
| proxyClusterInfo.maxUnitNum | Number | Serverless ODPのスケーリング可能なユニット数の上限。 | 3.0 |
| proxyClusterInfo.slaveZone | String | スタンバイノードのゾーン。2ゾーンまたは3ゾーンのプライマリ・スタンバイ構成でデプロイした場合にのみ返されます。 | zone-a |
| proxyClusterInfo.nodeDistribution | String | ノード配置、deployModeの代替。 | zone-a:1,zone-b:1 |
| proxyClusterInfo.nodeCpu | Number | ノード仕様、unitSpec * unitNumの代替。 | 4.0 |
| proxyClusterInfo.nodeNum | Integer | ノード数。 | 3 |
| proxyClusterInfo.deploymentArchitecture | String | デプロイ方式。商用化されていない既存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 |
| 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**** |
| 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-a |
| intranetAddressSlaveZoneId | String | セカンダリゾーンID | zone-b |
| intranetProxyClusterId | String | プライベートネットワークプロキシクラスタID。 | proxy-12**** |
| privateLinkList | Array | PrivateLinkリスト情報 | [{"endpointId": "ep-xxxxxx", "status": "CONNECTED"}] |
data[].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 |
例
リクエスト例
curl --digest \
-u '<Your AccessKey ID:AccessKey Secret>' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?requestId={requestId}&addressId={addressId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理 を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": [
{
"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": [
{
"value": "prod",
"weight": 1,
"readOnlyReplicaType": "FULL"
}
],
"disasterRecoveryReplicaParams": [
{
"value": "prod",
"weight": 1,
"readOnlyReplicaType": "FULL"
}
],
"balancedStrategy": "BALANCED",
"disasterRecoveryStrategy": "PRIMARY_FIRST"
},
"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****",
"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-a",
"intranetAddressSlaveZoneId": "zone-b",
"intranetProxyClusterId": "proxy-12****",
"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
}
]
}
],
"cost": 1.0,
"server": "10.0.0.10",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": {}
}