ModifyOdpClusterSpec - データベースプロキシクラスタの仕様を変更する|OceanBase Cloud|ドキュメント|分散データベース

ModifyOdpClusterSpec - データベースプロキシクラスタの仕様を変更する

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

機能の概要

このAPIは、データベースプロキシクラスタの仕様設定を変更するために使用されます。

呼び出しの説明

インターフェース制約

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

リクエストパス

POST /api/v2/instances/{instanceId}/proxies

リクエストパラメータ

Path

名前	型	必須	説明	サンプル値
instanceId	string	はい	OB CloudクラウドデータベースインスタンスID。	obcluster-*****

Query

名前	型	必須	説明	サンプル値
requestId	String	はい	リクエストID。追跡に使用されます	dc302d76-66b5-48d8-ab53-a035********

Body

名前	型	必須	説明	サンプル値
instanceId	String	はい	インスタンスID	obcluster-*****
proxyClusterId	String	はい	プロキシクラスタID	proxy-6tvgz6z2****
unitNum	Integer	いいえ	仕様説明 ProxySettingでプロキシ設定を指定した場合、このパラメータは含まれているため、再度指定する必要はありません。	1
mode	String	いいえ	プロキシモード説明 ProxySettingでプロキシ設定を指定した場合、このパラメータは含まれているため、再度指定する必要はありません。	k8s_shared、k8s_exclusive
zone	String	いいえ	ゾーン説明 ProxySettingでプロキシ設定を指定した場合、このパラメータは含まれているため、再度指定する必要はありません。	ap-beijing-5
odpClusterNodeType	String	はい	ODPクラスタノードタイプ。ワンクリックPOCシナリオで使用されます	normal
ProxySetting	Object	いいえ	プロキシ設定。unitnum、mode、zoneなどのパラメータが含まれます。説明このパラメータは現在、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
UID	String	いいえ	ユーザーID
User_ID	String	いいえ	ユーザーID
requestId	String	いいえ	リクエストID
callerType	String	いいえ	呼び出し元のタイプ
accessKeyId	String	いいえ	アクセスキーID
securityToken	String	いいえ	セキュリティトークン
callerUid	String	いいえ	呼び出し元UID
callerBid	String	いいえ	呼び出し元BID
stsTokenCallerUid	String	いいえ	STSトークン呼び出し元UID
stsTokenCallerBid	String	いいえ	STSトークン呼び出し元BID
acceptLanguage	String	いいえ	受け入れ言語
pageNumber	Integer	いいえ	ページ番号
pageSize	Integer	いいえ	1ページあたりの表示数
mergedCallerBid	String	いいえ	メジャーコンパクション後の呼び出し元BID

戻り値

名前	型	説明	サンプル値
success	boolean	成功かどうか	true/false
errorCode	string	エラーコード	"E001"
errorMessage	string	エラーメッセージ	"操作成功"
data	object	業務データ	{...}
cost	integer[int64]	時間消費(ミリ秒)	150
server	string	サーバーアドレス	"xx.xxx.xx.xxx"
requestId	string	リクエストID	"req_20250811_001"
totalCount	integer[int64]	総数	100
extra	object	追加情報	{"key1": "value1"}

例

リクエスト例

説明

プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。

例1：proxySettingを使用してプロキシ設定を渡します。

curl --digest -u '<Your AK:SK>' \
  --request POST \
  --url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/proxies?requestId={requestId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Ob-Project-Id: <プロジェクトID>' \
  --data '{"instanceId":"obcluster-*****","proxyClusterId":"proxy-6tvgz6z2****","odpClusterNodeType":"normal","proxySetting":{"mode":"k8s_shared","deploymentArchitecture":"DUAL_AZ_ACTIVE_ACTIVE_DEPLOYMENT","nodeCpu":0.5,"zone":["us-east-1a","us-east-1b"],"slaveZone":[]}}'

例2：仕様パラメータを直接指定します。

curl --digest -u '<あなたのAK:SK>' \
  --request POST \
  --url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/proxies?requestId={requestId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Ob-Project-Id: <プロジェクトID>' \
  --data '{"instanceId":"obcluster-*****","proxyClusterId":"proxy-6tvgz6z2****","unitNum":2,"mode":"k8s_exclusive","zone":"ap-beijing-5","odpClusterNodeType":"normal"}'

戻り値の例

{
  "success": true,
  "errorCode": "E001",
  "errorMessage": "操作成功",
  "data": {},
  "cost": 150,
  "server": "xxx.xxx.x.xxx:xxxx",
  "requestId": "req_20250811_001",
  "totalCount": 100,
  "extra": {}
}

OceanBase

顧客事例