本文へジャンプします。

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

RegisterInstancesWithSecurityGroup

処理概要

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

ファイアウォールグループを指定するためには、ファイアウォールグループ名が必要です。削除済みのファイアウォールグループを指定した、管理外のファイアウォールグループを指定したなど、無効なファイアウォールグループを指定した場合は、エラーが返されます。

またサーバーを指定するためには、サーバー名が必要です。すでにファイアウォールグループに適用されているサーバーを指定した、削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

ファイアウォールグループへサーバーを適用するには、時間がかかることがあります。

API「DescribeSecurityGroups」のレスポンス値「groupStatus」でファイアウォールグループのステータスを確認できます。
また、ファイアウォールグループのステータスが「適用済み」の場合、適用したサーバーが正しくファイアウォールグループに反映されているかの確認が必要です。
同じくAPI「DescribeSecurityGroups」のレスポンス値「instancesSet」で確認できます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
GroupName ファイアウォールグループ名
Type : String
group01
InstanceId.n サーバー名
Type : String
server04

応答フィールド

フィールド(項目) 説明 サンプル値
RegisterInstances
WithSecurityGroupResponse
RegisterInstancesWithSecurityGroup レスポンス
Type : RegisterInstancesWithSecurityGroupResponseType
Ancestor : なし
Children : requestId, instancesSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : RegisterInstancesWithSecurityGroupResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
instancesSet 適用に成功したサーバーの情報セット
Type : InstanceIdSetType
Ancestor : RegisterInstancesWithSecurityGroupResponse
Children : item
 
item 適用に成功したサーバーの情報
Type : InstanceIdType
Ancestor : InstancesSet
Children : InstanceId
 
instanceId サーバー名
Type : xsd:string
Ancestor : item
Children : なし
server04

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=RegisterInstancesWithSecurityGroup&GroupName=group01
&InstanceId.1=server04&InstanceId.2=server05&CommonParams

応答サンプル

<RegisterInstancesWithSecurityGroupResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>320fc738-a1c7-4a2f-abcb-20813a4e997c</requestId>
  <instancesSet>
   <item>
    <instanceId>server04</instanceId>
   </item>
   <item>
    <instanceId>server05</instanceId>
   </item>
  </instancesSet>
</RegisterInstancesWithSecurityGroupResponse>

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

APIメニュー

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

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