機能の概要
このAPIは、指定されたテナントに新しいネットワーク接続アドレスを作成するために使用されます。仮想IPサービスタイプ、VPC接続情報、およびプロキシ設定を構成することで、テナントの新しいアクセスエンドポイントを確立し、アプリケーションがOB Cloudデータベースインスタンス内のテナントに接続できるようにします。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/address
リクエストパラメータ
パスパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
クエリパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
リクエストヘッダーパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| X-Ob-Project-Id | string | はい | プロジェクトID。 | hxq3ztx3377nby3v87ry**** |
リクエストボディパラメータ
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| vipServiceType | string | はい | 仮想IPサービスタイプ。 | - |
| vpcConnectionInfoId | integer | はい | VPC接続情報ID。 | - |
| proxySetting | object | いいえ | プロキシ設定情報。 | - |
実行結果
パラメータ名 |
型 |
説明 |
|---|---|---|
| data | object | 戻されるデータオブジェクト。 |
| message | string | リクエストの応答メッセージ。 |
| successful | boolean | リクエストが成功したかどうか。 |
例
リクエスト例
curl -X POST \
-H "Content-Type: application/json" \
-H "X-Ob-Project-Id: hxq3ztx3377nby3v87ry****" \
-u '<Your AccessKey ID:AccessKey Secret>' \
"https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?requestId={requestId}" \
-d '{
"vipServiceType": "string",
"vpcConnectionInfoId": 0,
"proxySetting": {}
}'
実行結果例
{
"data": {},
"message": "Success",
"successful": true
}