機能説明
このインターフェースは、テナントのPrivateLinkプライベートネットワーク接続アドレス情報を照会するために使用され、VPC内部ネットワークアクセスに利用されます。
説明
このインターフェースは、Alibaba Cloudインスタンスからの呼び出しをサポートしていません。
呼び出し説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink
リクエストパラメータ
名前 |
タイプ |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID。 | obcluster-***** |
| tenantId | String | はい | テナントID。 | t4louaeei**** |
| requestId | String | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
| addressId | String | いいえ | アドレスID。 | rs-private-internet-***** |
実行結果
名前 |
タイプ |
説明 |
例値 |
|---|---|---|---|
| data | array[Object] | テナントリンク情報リスト | |
| data.addressId | string | アドレスID。 | rs-private-intranet-vpc-xxxxx-OBPROXY-INTRANET-xxxxxxx |
| data.addressStatus | string | アドレスステータス。取り得る範囲： |
PENDING_CREATE |
| data.addressType | string | アドレスタイプ。取り得る範囲： |
MASTER |
| data.connectionZones | array[string] | 接続地域 | ["ap-beijing-4"] |
| data.networkType | string | アドレスタイプ。取り得る範囲： |
INTRANET |
| data.privateLinkEndpointId | string | エンドポイントID。 | vpce-xxxxxx |
| data.privateLinkServiceAccount | string | アカウントID。 | 10003xxxxxx |
| data.privateLinkServiceId | string | サービスID。 | vpcsvc-xxxxx |
| data.privateLinkUserAccount | string | ユーザーアカウント。 | 10002xxxxxx |
| data.role | string | テナント権限。値の範囲：
|
READWRITE |
| data.userNameFormat | string | ユーザー名の接続文字列形式。形式： USER_AND_TENANT：ユーザー名@テナント名。 |
USER_AND_TENANT |
| requestId | string | リクエストID。 | 8fb87c78---****-00b1c8e5af7b |
| success | boolean | クエリ操作が成功したかどうか。値の範囲： |
true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request GET \
-H 'X-Ob-Project-Id: {projectId}' \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/privatelink?requestId={requestId}&addressId={addressId}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": [{
"addressId": "rs-private-intranet-vpc-xxxxx-OBPROXY-INTRANET-xxxxxxx",
"addressStatus": "PENDING_CREATE",
"addressType": "MASTER",
"connectionZones": ["ap-beijing-4"],
"networkType": "INTRANET",
"privateLinkEndpointId": "vpce-xxxxxx",
"privateLinkServiceAccount": "10003xxxxxx",
"privateLinkServiceId": "vpcsvc-xxxxx",
"privateLinkUserAccount": "10002xxxxxx",
"role": "READWRITE",
"userNameFormat": "USER_AND_TENANT"
}],
"requestId": "8fb87c78-****-****-****-00b1c8e5af7b",
"success": true
}