本文へジャンプします。

ニフティクラウド APIリファレンス

AuthorizeSecurityGroupIngress

処理概要

指定したファイアウォールグループへ許可ルールを追加します。

ファイアウォールグループを指定するためには、ファイアウォールグループ名が必要です。
削除済みのファイアウォールグループを指定した、管理外のファイアウォールグループを指定したなど、無効なファイアウォールグループを指定した場合は、エラーが返されます。
許可ルールの許可プロトコルがTCPかUDPの場合、許可ポートの指定が必要です。ポートを単一指定する際は、許可開始ポートのみを指定します。ポートを範囲指定する際は、許可終了ポートには許可開始ポートの値以上を指定します。
許可ルールの追加には、時間がかかることがあります。API「DescribeSecurityGroups」のレスポンス値「groupStatus」でファイアウォールグループのステータスを確認できます。
また、ファイアウォールグループのステータスが「適用済み」の場合、追加した許可ルールが正しくファイアウォールグループに反映されているかの確認が必要です。
同じくAPI「DescribeSecurityGroups」のレスポンス値「ipPermissions」または「groups」で確認できます。
許可ルールの上限数を超える場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
UserId ※指定不可
Type : String
   
GroupName 対象のファイアウォールグループ名
Type : String
group01
IpPermissions.n.IpProtocol 許可プロトコル名
Type : String
値 : ANY | TCP | UDP | ICMP | SSH | HTTP | HTTPS | RDP | GRE | ESP | AH | VRRP | L2TP | ICMPv6-all
Default : TCP
  HTTP
IpPermissions.n.FromPort 許可開始ポート
Type : Integer
Default : ipProtocolでの指定値による

(ipProtocol=
TCP|UDPの場合)
80
IpPermissions.n.ToPort 許可終了ポート
Type : Integer
Default : fromPortの値
  81
IpPermissions.n.InOut Incoming/Outgoing指定
Type : String
値 : IN (Incoming) | OUT (Outgoing)
Default : IN (Incoming)
   
IpPermissions.n.Groups.
m.UserId
※指定不可
Type : String
   
IpPermissions.n.Groups.
m.GroupName
許可するファイアウォールグループ名
Type : String

(IpPermissions.n.IpRanges.m.CidrIp といずれか)
 
IpPermissions.n.IpRanges.
m.CidrIp
許可するIPアドレス(IPv4, IPv6)
※CIDR指定可
Type : String

(IpPermissions.n.Groups.m.GroupName といずれか)
0.0.0.0/0
IpPermissions.n.Description 許可ルールのメモ
Type: string
   

応答フィールド

フィールド(項目) 説明 サンプル値
AuthorizeSecurityGroup
IngressResponse
AuthorizeSecurityGroupIngress レスポンス
Type : AuthorizeSecurityGroupIngressResponseType
Ancestor : なし
Children : requestId, return
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : AuthorizeSecurityGroupIngressResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
return 処理ステータス
Type : xsd:boolean
値 : true (成功)
Ancestor : AuthorizeSecurityGroupIngressResponse
Children : なし
true

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action= AuthorizeSecurityGroupIngress&GroupName=group01 &IpPermissions.1.IpProtocol=TCP&IpPermissions.1.FromPort=80 &IpPermissions.1.ToPort=81 &IpPermissions.1.IpRanges.1.CidrIp=0.0.0.0%2f0&IpPermissions.1.IpRanges.2.CidrIp=1%3a1%3a1%3a1%3a1%3a1%3a1%3a1%2f64&IpPermissions.1.Description=GroupMemoUpdate&CommonParams

応答サンプル

<AuthorizeSecurityGroupIngressResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <return>true</return>
</AuthorizeSecurityGroupIngressResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上