機能説明
このAPIは、テナントのPrivateLink接続を有効にするために使用されます。
説明
このAPIはAlibaba Cloudインスタンスでは呼び出せません。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/service
リクエストパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
| requestId | String | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| userAccount | String | はい | ユーザーアカウント情報。 | user123 |
| plServiceId | String | はい | PrivateLinkサービスID。 | pls-xxxxx |
| serviceType | String | はい | サービスタイプ。 | OBProxy |
| isSharedPlService | Boolean | はい | 共有されたPrivateLinkサービスかどうか。 | false |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| addressId | string | アドレスID。 | rs-private-intranet-vpc-XXXXXX-OBPROXY-INTRANET-XXXXXX |
| requestId | string | リクエストID。 | e448d60c-****-****-****-d33295124beb |
| success | string | 有効化操作が成功したかどうか。取り得る範囲： |
true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request POST \
-H 'X-Ob-Project-Id: <Project ID>' \
-H 'Content-Type: application/json' \
--data '{"userAccount": "user123", "plServiceId": "pls-xxxxx", "serviceType": "OBProxy", "isSharedPlService": false}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/service?requestId={requestId}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data":{
"addressId":"rs-private-intranet-vpc-XXXXXX-OBPROXY-INTRANET-XXXXXX"
},
"requestId":"e448d60c-****-****-****-d33295124beb",
"success":true
}