機能の概要
このAPIは、インスタンスの許可リストグループを作成するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
POST /api/v2/instances/{instanceId}/securityIpGroups
リクエストパラメータ
Path
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | String | はい | OceanBaseクラスタID | obcluster-***** |
Query
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Body
パラメータ名 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| securityIpGroupName | String | はい | IPセキュリティ許可リストグループの名前 | all |
| securityIps | String | はい | IP許可リストグループ内のIPアドレスまたはアドレス範囲。JSON形式の配列で、配列内の各要素はIP文字列またはIPアドレス範囲です。
|
["192.168.0.0/20", "192.169.1.1"] |
戻り値
名称 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | 戻り値 | |
| instanceId | String | インスタンスID | obxxx |
| securityIpGroupName | String | IPセキュリティ許可リストグループ名 | all |
| securityIps | String | IPセキュリティ許可リスト、JSON配列の文字列表現 | ["127.0.0.1"] |
| requestId | String | リクエストID | 5955b710-cb29-4056-81b4-0832b048e0c4 |
| success | Boolean | 成功かどうか | true |
例
リクエスト例
curl --digest -u '<Your AccessKey ID:AccessKey Secret>' \
--request POST \
https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/securityIpGroups?requestId={requestId} \
--header 'Content-Type: application/json' \
--data '{
"securityIpGroupName": "all",
"securityIps": "[\"127.0.0.1\"]"
}'
レスポンス例
JSON形式
{
"data":{
"instanceId":"obxxx",
"securityIpGroupName":"all",
"securityIps":"[\"127.0.0.1\"]"
},
"requestId":"5955b710-cb29-4056-81b4-0832b048e0c4",
"success":true
}
パブリッククラウドとの違い
securityIpsはJSON配列の文字列表現であるため、エスケープ処理にご注意ください。