機能の概要
このAPIは、指定されたインスタンスのアローリスト設定（IPセキュリティアローリストグループの名前とIPリスト）を変更するために使用されます。変更後の設定が有効になるまでには、一定の時間がかかる場合があります。
呼び出しの説明
インターフェース制約
呼び出し元は、マルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
PUT /api/v2/instances/{instanceId}/securityIpGroups
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudデータベースインスタンスID | obcluster-***** |
Query
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
例値 |
|---|---|---|---|---|
| instanceId | String | はい | インスタンスID | obcluster-***** |
| securityIps | String | はい | IPセキュリティアローリストのリスト。JSON形式の配列で、配列内の各オブジェクトはIP文字列またはIPアドレス帯域です。最大40個を設定できます。 | ["192.168.0.0/20", "192.169.1.1"] |
| securityIpGroupName | String | はい | IPセキュリティアローリストグループの名前。小文字の英字で始まり、小文字の英字または数字で終わり、小文字の英字、数字、アンダースコアのみを含み、長さは2～32文字です。 | all |
戻り結果
名前 |
型 |
説明 |
例値 |
|---|---|---|---|
| data | object | リクエストの戻り結果 | 表を参照 |
| instanceId | String | インスタンスID | obcluster-***** |
| securityIpGroupName | String | IPセキュリティホワイトリストグループ名 | all |
| securityIps | String | IPセキュリティホワイトリストリスト | ["127.0.0.1"] |
| requestId | String | リクエストID | 5955b710-cb29-4056-81b4-0832b048e0c4 |
| success | Boolean | 成功かどうか | true |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
-X PUT \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/securityIpGroups?requestId={requestId}' \
-H 'Content-Type: application/json' \
-d '{
"instanceId": "obcluster-*****",
"securityIpGroupName": "all",
"securityIps": "[\"192.168.0.0/20\", \"192.169.1.1\"]"
}'
戻り値例
JSON形式
{
"data": {
"instanceId": "obcluster-*****",
"securityIpGroupName": "all",
"securityIps": "[\"192.168.0.0/20\", \"192.169.1.1\"]"
},
"requestId": "5955b710-cb29-4056-81b4-0832b048e0c4",
"success": true
}