List security group rules#
セキュリティグループルールを一覧表示します。
APIエンドポイント#
リージョン | APIエンドポイント |
---|---|
西日本リージョン3の場合 | https://networking.jp-west-3.cloud.global.fujitsu.com |
東日本リージョン3の場合 | https://networking.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v2.0/security-group-rules
HTTPステータスコード#
正常時:200
エラー時:401
リクエストパラメータの説明#
名前 | In | Type | デフォルト値 /必須指定 |
Description |
---|---|---|---|---|
remote_group_id | query | string | 任意 | 結果をセキュリティグループルールに関連付けられているリモートグループで絞り込みます。 |
direction | query | string | 任意 | 結果を測定ルールの適用方向(ingressまたはegress)で絞り込みます。 |
protocol | query | string | 任意 | 結果をIPプロトコルで絞り込みます。 |
ethertype | query | string | 任意 | 結果をネットワークトラフィックのIPタイプ(IPv4またはIPv6)で絞り込みます。 |
port_range_max | query | integer | 任意 | 最大ポート番号を指定し、結果をセキュリティグループルールのポート番号範囲で絞り込みます。 protocolがICMPの場合は、ICMPコードを指定ます。 |
security_group_id | query | string | 任意 | 結果をセキュリティグループルールに関連付けられているセキュリティグループIDで絞り込みます。 |
tenant_id | query | string | 任意 | 結果をプロジェクトIDで絞り込みます。 |
project_id | query | string | 任意 | 結果をプロジェクトIDで絞り込みます。 |
port_range_min | query | integer | 任意 | 最小ポート番号を指定し、結果をセキュリティグループルールのポート番号範囲で絞り込みます。 protocolがICMPの場合は、ICMPタイプを指定します。 |
revision_number | query | integer | 任意 | 結果をリソースの改訂番号で絞り込みます。 |
id | query | string | 任意 | 結果をリソースのIDで絞り込みます。 |
description | query | string | 任意 | 結果をリソースの説明で絞り込みます。 |
fields | query | string | 任意 | 一覧表示する属性を指定します。 省略した場合は、すべての属性が表示されます。 複数指定ができます。 例えば、 fields=id&fields=name と指定すると、「id」と「name」の属性だけが表示されます。 |
レスポンスボディ(正常系)の説明#
名前 | Type | Description |
---|---|---|
security_group_rules | array | セキュリティグループルールのオブジェクト |
remote_group_id | string | セキュリティグループルールに関連付けられるリモートグループのUUID リクエストボディに「remote_group_id」または「remote_ip_prefix」が指定できます。 |
direction | string | 測定ルールの適用方向 「ingress」または「egress」です。 |
protocol | string | IPプロトコル 「string」、「integer」、または「null」が設定できます。有効な指定値は以下のとおりです。 以下のうちどれかが表示されます。 - icmpまたは1 - icmpv6または58 - tcpまたは6 - udpまたは17 - 0~142の任意の整数 |
ethertype | string | ネットワークトラフィックのIPタイプ IPv4が表示されます。 CIDRのアドレスはingressとegressのルールに一致する必要があります。 |
port_range_max | integer | 最大ポート番号 protocolがTCP、UDP、DCCP、SCTP、UDP-Liteの場合は、port_range_minの値以上の値が必要です。protocolがICMPの場合は、ICMPコードが表示されます。 |
security_group_id | string | 関連付けるセキュリティグループのID |
tenant_id | string | プロジェクトのID |
project_id | string | プロジェクトのID |
port_range_min | integer | 最小ポート番号 protocolがTCP、UDP、DCCP、SCTP、UDP-Liteの場合は、port_range_maxの値以下の値が必要です。protocolがICMPの場合は、ICMPタイプが表示されます。 |
remote_ip_prefix | string | セキュリティグループルールに関連付けるリモートIPのプレフィックス [0.0.0.0/0]に指定することで、全通信を許可することが可能です。 |
revision_number | integer | リソースの改訂番号 |
id | string | セキュリティグループルールID |
description | string | リソースの説明 |
レスポンス例#
{ "security_group_rules": [ { "direction": "egress", "ethertype": "IPv6", "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "project_id": "e4f50856753b4dc6afee5fa6b9b6c550", "revision_number": 1, "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", "description": "" }, { "direction": "egress", "ethertype": "IPv4", "id": "93aa42e5-80db-4581-9391-3a608bd0e448", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "project_id": "e4f50856753b4dc6afee5fa6b9b6c550", "revision_number": 1, "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", "description": "" }, { "direction": "ingress", "ethertype": "IPv6", "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "project_id": "e4f50856753b4dc6afee5fa6b9b6c550", "revision_number": 2, "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", "description": "" }, { "direction": "ingress", "ethertype": "IPv4", "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", "port_range_max": null, "port_range_min": null, "protocol": null, "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "project_id": "e4f50856753b4dc6afee5fa6b9b6c550", "revision_number": 1, "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", "description": "" } ] }