機能の概要
この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
}