機能の概要
このAPIは、PrivateLinkによるプライベートネットワーク接続の完了を確認するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/confirmation
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | ob2mr3oae0**** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID | 6e87d618-854e-4ca1-ae1f-babc******** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| endpointId | String | はい | endpoint ID | |
| addressId | String | いいえ | VIPサービスグループ名、オプション | |
実行結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| success | boolean | 操作の成功 | true/false |
| errorCode | string | エラーコード | "E001" |
| errorMessage | string | エラーメッセージ | "操作は成功しました" |
| data | boolean | 業務データ | {...} |
| 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 '<Your AccessKey ID:AccessKey Secret>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/confirmation?requestId={requestId}' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
--data '{"endpointId": "{endpointId}", "addressId": "{addressId}"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": true,
"requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000",
"success": true,
"server": "xxx.xxx.x.xxx:xxxx"
}