機能の概要
このAPIは、テナントのsingleTunnelSLBアドレスを新規作成するために使用されます。
説明
このAPIは、クラウドベンダーがAlibaba Cloudのインスタンス内のテナントにのみ適用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/tenantSingleTunnelSLBAddress
リクエストパラメータ
Path
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID | 6e87d618-854e-4ca1-ae1f-babc******** |
Body
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| userVpcId | String | はい | ユーザーVPC ID | your-vpc-id |
| userVpcOwnerId | String | はい | VCP所有者ID | your-vpc-owner-id |
| userVswitchId | String | はい | ユーザーVswitch ID | your-vswitch-id |
| vipServiceType | String | はい | アドレスタイプ | OBPROXY_INTRANET、OBPROXY_INTERNET、OBPROXY_READONLY、OBPROXY_READWRITE...... |
| zoneIdList | List |
いいえ | ユーザーが選択したゾーン | ["cn-bj-d"] |
| trafficStrategy | トラフィック戦略 | いいえ | AVAILABLE_ZONE_PRIORITY：同じ可用ゾーン優先、AUTO_BALANCE：自動バランシング、CUSTOM_WEIGHT：カスタム重み | |
| replicaParams | String | いいえ | レプリカの選択 | [{"Value":"FULL", "weight": 0,"readOnlyReplicaType": ""}] |
| disasterRecoveryReplicaParams | String | いいえ | 災害復旧レプリカの選択 | 上記と同じ |
| balancedStrategy | String | いいえ | バランシング戦略 | AVAILABLE_ZONE_PRIORITY：同じ可用ゾーン優先、AUTO_BALANCE：自動バランシング、CUSTOM_WEIGHT：カスタム重み |
| disasterRecoveryStrategy | String | いいえ | 災害復旧戦略。レプリカが使用できない場合、プライマリレプリカを自動的に検索します。 | YES |
戻り値
名称 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | 成功かどうか | true/false |
| errorCode | string | エラーコード | "E001" |
| errorMessage | string | エラーメッセージ | "操作成功" |
| data | object | 業務データ | {...} |
| data.addressId | string | vip service group name | "12345" |
| cost | integer[int64] | 時間消費(ミリ秒) | 150 |
| server | string | サーバーアドレス | "xx.xxx.xx.xxx" |
| requestId | string | リクエストID | "req_20250811_001" |
| totalCount | integer[int64] | 総数 | 100 |
| extra | object | 追加情報 | {"key1": "value1"} |
例
リクエスト例
curl --digest -u 'ak:sk' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/tenantSingleTunnelSLBAddress'\
-H 'X-Ob-Project-Id: <プロジェクトID>'\
--data \ '{"userVpcId":"xxx", "userVpcOwnerId": "xxx", "userVswitchId": "xxx", "vipServiceType": "OBPROXY_INTRANET"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値例
JSON形式
{
"data": {
"addressId": "rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-****"
},
"requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000",
"success": true
}