機能の概要
このAPIは、テナントの許可リストグループ一覧を取得するために使用されます。許可リストの詳細な使用方法については、テナントのホワイトリストグループの設定を参照してください。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
リクエストパラメータ
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | テナントの許可リスト情報。dataListプロパティフィールドを含みます。 | |
| dataList | object[] | テナントの許可リスト情報の一覧。プロパティは下記を参照してください。 | |
| tenantId | string | テナントID。 | t4louaeei**** |
| securityIpGroupName | string | グループ名。 | test1 |
| securityIpGroupType | string | 許可リストグループタイプ。
|
tenant |
| securityIps | string | 許可リスト。カンマ区切りの文字列で、各要素はIP文字列またはIPアドレス範囲です。 | 192.***.*.* |
例
リクエスト例
curl \
--digest -u 'xxx:xxx' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups \
-H 'X-Ob-Project-Id: <プロジェクトID>'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
戻り値の例
JSON形式
{
"data": {
"dataList": [
{
"securityIpGroupName": "zhi****test",
"securityIpGroupType": "tenant",
"securityIps": "[\"127.x.x.x\", \"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
{
"securityIpGroupName": "s****",
"securityIpGroupType": "tenant",
"securityIps": "[\"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
}
],
"total": 2
},
"requestId": "b****12121212",
"success": true
}