Create security group rule
セキュリティグループルールを作成します。
URI
/v2.0/security-group-rules
HTTPメソッド
POST
リクエストパラメタ
キー | 説明 | 型 | 必須/省略可 |
---|---|---|---|
direction | ingressまたはegress。セキュリティグループルールが適用される通信方向。コンピュートインスタンスの場合、ingressセキュリティグループルールは受信(ingress)トラフィックに適用されます。egressルールは、インスタンスから送信トラフィックに適用されます。 | xsd:string | Required |
port_range_min | セキュリティグループルールに一致する範囲の最小ポート番号
プロトコルがTCPまたはUDPのとき、この値はport_range_maxの値以下でなければなりません。この値を指定しなければ、セキュリティグループルールはすべてのポート番号に適用されます。 port_range_minが"0"の場合、port_range_maxの値に関係なく、すべてのポート番号が許可されます。 プロトコルがICMPの場合、この値にICMPタイプを指定する必要があります。この値を指定しなければ、セキュリティグループルールはすべてのICMPタイプに適用されます。 |
xsd:int | Optional |
ethertype | IPv4である必要があり、CIDR表記のアドレスがingressルールまたはegressルールと一致する必要があります。
指定しなければ、IPv4が設定されます。 |
xsd:string | Optional |
port_range_max | セキュリティグループルールに一致する範囲の最大ポート番号
プロトコルがTCPまたはUDPのとき、port_range_min属性はport_range_max属性の制約を受けます。 プロトコルがICMPの場合、この値にICMPコードを指定する必要があります。この値を指定しなければ、セキュリティグループルールはすべてのICMPコードに適用されます。 |
xsd:int | Optional |
protocol | セキュリティグループルールに一致するプロトコル
有効な数値は、null、tcp、udp、icmp、および、0~255の数字です。 |
xsd:string | Optional |
remote_group_id | このセキュリティグループと関連付ける通信先のセキュリティグループのID
リクエストボディ部では、remote_group_idまたはremote_ip_prefixを指定できます。 |
csapi:uuid | Optional |
security_group_id | セキュリティグループID | csapi:uuid | Required |
remote_ip_prefix | このセキュリティグループと関連付けるリモートIPのプレフィックス
リクエストボディ部では、remote_group_idまたはremote_ip_prefixを指定できます。本属性は、IPパケットの発信先IPアドレスまたは宛先IPアドレスの指定されたIPプレフィックスに一致します。方向がingressであれば発信先IPアドレスに一致し、そうでなければ宛先IPアドレスに一致します。 |
xsd:string | Optional |
リクエスト例
{
"security_group_rule": {
"direction": "ingress",
"port_range_min": "80",
"ethertype": "IPv4",
"port_range_max": "80",
"protocol": "tcp",
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a"
}
}
レスポンスステータス
ステータスコード | 説明 |
---|---|
201 | Normal response codes |
badRequest (400) | Error response codes |
unauthorized (401) | Error response codes |
itemNotFound (404) | Error response codes |
buildInProgress (409) | Error response codes |
レスポンスボディ(正常系)
{
"security_group_rule": {
"direction": "ingress",
"ethertype": "IPv4",
"id": "2bc0accf-312e-429a-956e-e4407625eb62",
"port_range_max": 80,
"port_range_min": 80,
"protocol": "tcp",
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"remote_ip_prefix": null,
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
}
}
レスポンスボディ(正常系)の説明
要素名 | 説明 |
---|---|
id | セキュリティグループルールID |
direction | ingressまたはegress
セキュリティグループルールが適用される通信方向。コンピュートインスタンスの場合、ingressセキュリティグループルールは受信(ingress)トラフィックに適用されます。egressルールは、インスタンスから送信トラフィックに適用されます。 |
port_range_min | セキュリティグループルールに一致する範囲の最小ポート番号
プロトコルがTCPまたはUDPのときに、この値が指定されていない場合、セキュリティグループルールはすべてのポート番号に適用されます。 port_range_minが"0"の場合、port_range_maxの値に関係なく、すべてのポート番号が許可されます。 プロトコルがICMPの場合、この値にICMPタイプを指定する必要があります。この値が"null"の場合、セキュリティグループルールはすべてのICMPタイプに適用されます。 |
ethertype | IPv4またはIPv6を指定する必要があります。また、CIDR表記のアドレスがingressルールまたはegressルールと一致する必要があります。 |
port_range_max | セキュリティグループルールに一致する範囲の最大ポート番号。
プロトコルがICMPのときに、この値が指定されていない場合、セキュリティグループルールはすべてのICMPコードに適用されます。 |
protocol | セキュリティグループルールに一致するプロトコル
有効な数値は、null、tcp、udp、icmp、および、0~255の数字です。 |
remote_group_id | 先のセキュリティグループのID リクエストボディ部では、remote_group_idまたはremote_ip_prefixを指定できます。 |
security_group_id | セキュリティグループID |
remote_ip_prefix | このセキュリティグループと関連付けるリモートIPのプレフィックス
本属性は、IPパケットの発信先IPアドレスまたは宛先IPアドレスの指定されたIPプレフィックスに一致します。方向がingressであれば発信先IPアドレスに一致し、そうでなければ宛先IPアドレスに一致します。 |