機能の概要
このAPIは、テナントのセキュリティ許可リスト情報を作成するために使用されます。許可リストの詳細な使用方法については、テナントアローリストグループの設定を参照してください。
注意
現在、このAPIの許可リスト機能は利用可能です。利用する場合は、テクニカルサポートにお問い合わせください。
呼び出しの説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups
リクエストパラメータ
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OceanBase CloudデータベースインスタンスID。 | ob317v4uif**** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
| requestId | string | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
項目 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| securityIps | string | はい | IPセキュリティ許可リストです。JSON形式の配列で、配列内の各オブジェクトはIP文字列またはIPアドレス範囲です。最大40個を設定できます。 | "["192.*.."]" |
| securityIpGroupName | string | はい | IPセキュリティ許可リストグループの名前です。小文字の英字で始まり、小文字の英字または数字で終わります。小文字の英字、数字、アンダースコアのみを含み、長さは2～32文字です。 | paytest |
戻り値
項目 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | テナントのセキュリティ許可リスト情報。 | |
| tenantId | string | テナントID。 | t4louaeei**** |
| securityIpGroupName | string | 許可リストグループ名。 | paytest |
| securityIpGroupType | string | 許可リストグループタイプ。
|
|
| securityIps | string | 許可リスト。カンマ区切りの文字列で、各要素はIPアドレスまたはIPアドレス範囲です。 | "["192.*.."]" |
例
リクエスト例
curl -v --location \
--digest -u '<Your AccessKey ID:AccessKey Secret>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/securityIpGroups?requestId={requestId}' \
-H 'X-Ob-Project-Id: <プロジェクトID>' \
-H 'Content-Type: application/json' \
--data '{"securityIps":"[\"192.*..\"]", "securityIpGroupName": "paytest"}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- インスタンスIDが属するプロジェクトのIDと指定したプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"data": {
"instanceId": "ob3n****7mx9c",
"securityIpGroupName": "zhi****111",
"securityIps": "[\"127.x.x.x\", \"x.x.x.x\"]",
"tenantId": "t****2u5q6l4w"
},
"requestId": "b****1010",
"success": true
}