機能の概要
このAPIは、テナントのPrivateLinkプライベートネットワーク接続アドレス情報を照会するために使用され、VPCの内部ネットワークからのアクセスに利用されます。
説明
このAPIはAlibaba Cloudインスタンスでは呼び出しできません。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink
リクエストパラメータ
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 | 業務データ(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[] オブジェクトのフィールド
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| vpcId | String | VPC識別子。 | vpc-xxxx**** |
| userVpcOwnerId | String | ユーザーVPCが属するアカウントの識別子。 | 20000600**** |
| vSwitchId | String | スイッチ識別子。 | vsw-xxxx**** |
| connectionZones | Array | 接続ゾーン | ["zone-******"] |
| connectionLogicalZones | Array | 接続アドレスに関連付けられた論理ゾーンのリスト。 | ["zone-******"] |
| 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 | ゾーン。 | zone-****** |
| 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ゾーンのプライマリ/スタンバイ構成の場合にのみ返されます） | zone-****** |
| proxyClusterInfo.nodeDistribution | String | ノードの分布（ODPの商用化に伴い追加。deployModeに代わる項目） | zone-******1:1,zone-******2: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 | テナント接続アドレスの読み取りトラフィックのポリシー設定 | 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 | アドレスのプライマリゾーン | zone-****** |
| 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 | zone-****** |
| intranetAddressSlaveZoneId | String | セカンダリゾーンID | zone-****** |
| 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[].connectionLogicalZones[] の要素フィールド
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| data[].connectionLogicalZones[] | String | 接続アドレスに関連付けられた論理ゾーンのリスト。 | "zone-******" |
data[].connectionZones[] の要素フィールド
フィールド |
タイプ |
説明 |
値の例 |
|---|---|---|---|
| data[].connectionZones[] | String | 接続先のゾーン | "zone-******" |
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 \
-H 'X-Ob-Project-Id: {projectId}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink?requestId={requestId}&addressId={addressId}'
説明
- プロジェクト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-******"
],
"connectionLogicalZones": [
"zone-******"
],
"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": "zone-******",
"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-******",
"nodeDistribution": "zone-******1:1,zone-******2: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": "zone-******",
"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": "zone-******",
"intranetAddressSlaveZoneId": "zone-******",
"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"
}
],
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}