本文へジャンプします。

ニフクラ APIリファレンス

NiftyRegisterRoutersWithSecurityGroup

処理概要

指定したファイアウォールグループを、ルーターへ適用します。

下記の場合は、エラーが返されます。

  • 削除済みのファイアウォールグループを指定した場合
  • 管理外のファイアウォールグループを指定した場合
  • 無効なファイアウォールグループを指定した場合は

ルーターへ適用するには、ルーター名またはルーターユニークIDを指定します。
下記の場合は、エラーが返されます。

  • すでにファイアウォールグループに適用されているルーターを指定した場合
  • 削除済みのルーターを指定した場合
  • 管理外のルーターを指定した場合
  • 無効なルーターを指定した場合

ファイアウォールグループのルーター適用には、時間がかかることがあります。
「DescribeSecurityGroups」のレスポンス「groupStatus」にて適用ステータスを確認することができます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
GroupName ファイアウォールグループ名
Type : String
group01
RouterSet.n.RouterId ルーターユニークID
Type : String
○(ルーター名といずれか) rt-001
RouterSet.n.RouterName ルーター名
Type : String
○(ルーターユニークIDといずれか) router01

応答フィールド

フィールド(項目) 説明 サンプル値
NiftyRegisterRoutersWithSecurityGroupResponse NiftyRegisterRoutersWithSecurityGroupレスポンス
Type : NiftyRegisterRoutersWithSecurityGroupResponseType
Ancestor : なし
Children : requestId, routerSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyRegisterRoutersWithSecurityGroupResponse
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c
routerSet 適用に成功したルーターの情報セット
Type : RouterIdSetType
Ancestor : NiftyRegisterRoutersWithSecurityGroupResponse
Children : item
 
item 適用に成功したルーターの情報
Type : RouterIdSetItemType
Ancestor : routerSet
Children : routerId, routerName
 
routerId ルーターユニークID
  • ※ルーター名のいずれか一方が返却される。
Type : xsd:string
Ancestor : item
Children : なし
rt-0001
routerName ルーター名
  • ※routerIdのどちらか一方が設定される
Type : xsd:string
Ancestor : item
Children : なし
router01

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=NiftyRegisterRoutersWithSecurityGroup&GroupName=websrv&RouterSet.1.RouterName=router1

応答サンプル

<NiftyRegisterRoutersWithSecurityGroupResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <routerSet>
    <item>
      <routerName>router1</routerName>
    </item>
  </routerSet>
</NiftyRegisterRoutersWithSecurityGroupResponse>

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

APIメニュー

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

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