CreateReadwritePrivatelink - テナントのプライベートネットワーク読み書き分離アドレスを作成する|OceanBase Cloud|ドキュメント|分散データベース

CreateReadwritePrivatelink - テナントのプライベートネットワーク読み書き分離アドレスを作成する

最終更新日：2026-07-31 06:58:55 更新

機能の概要

このAPIは、指定されたOB Cloudデータベースインスタンスのテナントに対して、プライベートネットワークの読み書き分離アドレスを作成します。読み書き分離アドレスを設定することで、読み取りリクエストと書き込みリクエストを異なるデータベースノードに分散させ、データベースの同時実行処理能力と全体的なパフォーマンスを向上させることができます。

呼び出しの説明

インターフェース制約

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

リクエストパス

POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/readwrite

リクエストパラメータ

パスパラメータ

名前	型	必須	説明	サンプル値
instanceId	string	はい	OB CloudデータベースインスタンスID。	obcluster-*****
tenantId	string	はい	テナントID。	t4louaeei****

クエリパラメータ

名前	型	必須	説明	サンプル値
requestId	string	はい	追跡用のリクエストID。	dc302d76-66b5-48d8-ab53-a035********

リクエストボディパラメータ

名前	型	必須	説明	サンプル値
zoneIdList	array[string]	いいえ	ゾーンIDのリスト。説明 ProxySettingでプロキシ設定を渡す場合、このパラメータは既に含まれているため、再度指定する必要はありません。	["zone1", "zone2"]
userAccount	string	はい	ユーザーアカウント。	"test_user"
trafficStrategy	string	はい	トラフィック戦略。	"strategy_round_robin"
replicaParams	string	はい	レプリカパラメータ。	"{"replicaCount": 2}"
disasterRecoveryReplicaParams	string	いいえ	災害復旧レプリカパラメータ。	"{"drReplicaCount": 1}"
balancedStrategy	string	いいえ	バランス戦略。	"balanced"
disasterRecoveryStrategy	string	いいえ	災害復旧ポリシー。	"active-passive"
serviceType	string	はい	アドレスタイプ。	OBPROXY_READWRITE
ProxySetting	Object	いいえ	プロキシ設定。説明このパラメータは現在、AWSチャネルのインスタンスでのみサポートされています。
-mode	String	いいえ	プロキシクラスタの仕様タイプ。k8s_sharedまたはk8s_exclusiveをサポートします。	k8s_shared
-deploymentArchitecture	String	いいえ	プロキシクラスタのデプロイメント方式 SINGLE_AZ_DEPLOYMENT：単一アベイラビリティゾーンデプロイメント DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT：デュアルアベイラビリティゾーン・ダブルアクティブデプロイメント DUAL_AZ_ACTIVE_STANDBY_DEPLOYMENT：デュアルアベイラビリティゾーン・プライマリ/スタンバイデプロイメント	DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT
-zone	Array	いいえ	プライマリノードのアベイラビリティゾーン	["us-east-1a","us-east-1b"]
-slaveZone	Array	いいえ	スタンバイノードのアベイラビリティゾーン。デュアル/トリプルアベイラビリティゾーンのプライマリ/スタンバイデプロイメント方式を選択した場合にのみ設定します	[]
-nodeCpu	Float	いいえ	ノードの仕様	最小0.5、調整ステップは0.5

戻り値

パラメータ名	型	説明
code	string	戻りコード。
message	string	戻りメッセージ。
data	object	戻されるデータオブジェクト。
data.resourceId	string	作成されたプライベートネットワーク読み書き分離アドレスのリソースID。
data.status	string	リソースの作成状態。
data.requestId	string	リクエストID。

例

リクエスト例

例1：ProxySettingを使用してプロキシ設定を指定する

curl -X POST \
  'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/readwrite?requestId={requestId}' \
  -H 'Content-Type: application/json' \
  -u '<あなたのak:sk>' \
  -d '{
    "userAccount": "test_user",
    "trafficStrategy": "strategy_round_robin",
    "replicaParams": "{\"replicaCount\": 2}",
    "disasterRecoveryReplicaParams": "{\"drReplicaCount\": 1}",
    "balancedStrategy": "balanced",
    "disasterRecoveryStrategy": "active-passive",
    "serviceType": "OBPROXY_READWRITE",
    "proxySetting":{"mode":"k8s_shared","deploymentArchitecture":"DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT","nodeCpu":0.5,"zone":["us-east-1a","us-east-1b"],"slaveZone":[]}
  }'

例2：アベイラビリティゾーンIDのリストを直接指定する

curl -X POST \
  'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/readwrite?requestId={requestId}' \
  -H 'Content-Type: application/json' \
  -u '<あなたのak:sk>' \
  -d '{
    "zoneIdList": ["zone1", "zone2"],
    "userAccount": "test_user",
    "trafficStrategy": "strategy_round_robin",
    "replicaParams": "{\"replicaCount\": 2}",
    "disasterRecoveryReplicaParams": "{\"drReplicaCount\": 1}",
    "balancedStrategy": "balanced",
    "disasterRecoveryStrategy": "active-passive",
    "serviceType": "OBPROXY_READWRITE",
  }'

戻り値の例

{
  "code": "200",
  "message": "success",
  "data": {
    "resourceId": "privatelink-rw-xxxxxx",
    "status": "Creating",
    "requestId": "xxxxxx"
  },
  "server": "xxx.xxx.x.xxx:xxxx"
}

OceanBase

顧客事例