機能の概要
このAPIは、指定されたOceanBaseクラスタ内のテナントのPrivateLinkサービスにアローリストユーザーを追加するために使用されます。このAPIを使用することで、指定されたユーザーアカウントに対してそのテナントのプライベートネットワークサービスへのアクセス権限を付与し、アクセス制御とセキュリティを強化できます。
説明
このAPIはAlibaba Cloudインスタンスでは呼び出せません。
呼び出しの説明
インターフェースの制約
呼び出し元はマルチクラウドAPIにアクセスするための秘密鍵を保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
現在、このAPIはアローリストが開放されています。利用を希望する場合は、テクニカルサポートにお問い合わせください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/user
リクエストパラメータ
名前 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラウドデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | String | はい | テナントID。 | t33h8y08k**** |
| requestId | String | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| userAccount | String | はい | ユーザーアカウント情報。 | user123 |
| addressId | String | はい | アドレスID。 | rs-praivate-******** |
戻り値
名前 |
タイプ |
説明 |
例 |
|---|---|---|---|
| requestId | string | リクエストID。 | 167140a8-****-****-9ca1c646ae25 |
| 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", "addressId": "rs-praivate-********"}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink/user?requestId={requestId}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data":{},
"requestId":"167140a8-****-****-****-9ca1c646ae25",
"success":true
}