本文へジャンプします。

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

DeregisterInstancesFromLoadBalancer

処理概要

指定したロードバランサーから、指定したサーバーを解除します。

ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。自分が所有していないロードバランサーを指定する場合は、「@nifty法人ID.ロードバランサー名」の形式で指定する必要があります。削除済みのロードバランサーを指定した、管理外のロードバランサーを指定したなど、無効なロードバランサーを指定した場合は、エラーが返されます。

またサーバーを指定するためには、サーバー名が必要です。自分が所有していないサーバーを指定する場合は、「@nifty法人ID.サーバー名」の形式で指定する必要があります。該当するロードバランサーに設定されていないサーバーを指定した、削除済みのサーバーを指定した、管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

指定するパラメーター

パラメーター 説明 必須 サンプル値
LoadBalancerName ロードバランサー名
Type : String
lb0001
abc12345.lb0002
LoadBalancerPort 待ち受けポート
Type : Integer
443
InstancePort 宛先ポート
Type : Integer
443
Instances.member.n.
InstanceId
サーバー名
Type : String
server02

応答フィールド

フィールド(項目) 説明 サンプル値
DeregisterInstances
FromLoadBalancerResponse
DeregisterInstancesFromLoadBalancer レスポンス
Type : DeregisterInstancesFromLoadBalancerResponse
Ancestor : なし
Children : DeregisterInstancesFromLoadBalancerResult, ResponseMetadata
 
DeregisterInstances
FromLoadBalancerResult
処理結果の情報セット
Type : DeregisterInstancesFromLoadBalancerResult
Ancestor : DeregisterInstancesFromLoadBalancerResponse
Children : Instances
 
Instances 処理後の設定サーバーの情報セット
Type : InstanceUniqueIds
Ancestor : DeregisterInstancesFromLoadBalancerResult
Children : member
 
member 処理後の設定サーバーの情報
Type : InstanceUnique
Ancestor : Instances
Children : InstanceId, InstanceUniqueId
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
server03
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
i-abvf1234
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : DeregisterInstancesFromLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

https://cp.cloud.nifty.com/api/?Action=DeregisterInstancesFromLoadBalancer
& LoadBalancerName=lb0001&LoadBalancerPort=443&InstancePort=443
&Instances.member.1.InstanceId=server02&CommonParams

応答サンプル

<DeregisterInstancesFromLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
 <DeregisterInstancesFromLoadBalancerResult>
  <Instances>
   <member>
    <InstanceId>server03</InstanceId>
    <instanceUniqueId>i-abvf1234</instanceUniqueId>
   </member>
  </Instances>
 </DeregisterInstancesFromLoadBalancerResult>
 <ResponseMetadata>
  <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
 </ResponseMetadata>
</DeregisterInstancesFromLoadBalancerResponse>

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

APIメニュー

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

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