機能の概要
このインターフェースは、PrivateLinkエンドポイントノードを介してデータベースに接続するために使用されます。
説明
このインターフェースは、Alibaba Cloudインスタンスでは呼び出しできません。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDおよびAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/connection
リクエストパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
| requestId | String | はい | 追跡用のリクエストID。 | dc302d76-66b5-48d8-ab53-a035******** |
| endpointId | String | はい | クライアントID。 | t33h8y08k**** |
| addressId | String | いいえ | アドレスID。読み取り専用シナリオでは必須です。 | obe-4tw51gp7**** |
| userEndpointAddress | String | いいえ | ユーザーエンドポイントノードのアドレス。 |
実行結果
名前 |
型 |
説明 |
|---|---|---|
| requestId | string | リクエストID。 |
| success | string | 接続操作が成功したかどうか。 |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request POST \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"endpointId": "t33h8y08k****", "addressId": "obe-4tw51gp7****", "userEndpointAddress": ""}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/connection?requestId={requestId}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {},
"requestId": "ecf10c08-****-****-****-8a2e57897f74",
"success": true
}