機能の概要
このAPIは、インスタンスのホワイトリストグループを削除するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、アクセスキーの管理をご参照ください。
リクエストパス
DELETE /api/v2/instances/{instanceId}/securityIpGroups
リクエストパラメータ
Path
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBase CloudインスタンスID | obcluster-***** |
Query
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
パラメータ名 |
パラメータタイプ |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| securityIpGroupName | String | はい | IPセキュリティホワイトリストグループの名前。小文字の英字で始まり、小文字の英字または数字で終わり、小文字の英字、数字、アンダースコアのみ含み、長さは2～32文字です。 | all |
戻り値
パラメータ名 |
パラメータタイプ |
説明 |
サンプル値 |
|---|---|---|---|
| instanceId | String | インスタンスID。 | obxxx |
| securityIpGroupName | String | IPセキュリティホワイトリストグループの名前。 | all |
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request DELETE \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/securityIpGroups?requestId={requestId}' \
--header 'Content-Type: application/json' \
--data '{
"securityIpGroupName":"all"
}'
レスポンス例
JSON形式
{
"data":{
"instanceId":"obxxx",
"securityIpGroupName":"all"
},
"requestId":"f755e6ed-b53a-4d95-9948-15a0a7183e32",
"success":true
}