本文へジャンプします。

ニフクラ APIリファレンス

クラウド トップ>APIのご利用にあたって>ニフクラREST API>NiftyDeregisterInstancesFromElasticLoadBalancer

NiftyDeregisterInstancesFromElasticLoadBalancer

処理概要

指定したマルチロードバランサーから、指定したサーバーを解除します。
マルチロードバランサーを指定するためには、マルチロードバランサー名または、マルチロードバランサーユニークID・プロトコル・待ち受けポート番号・宛先ポート番号が必要です。削除済みのマルチロードバランサーを指定した、管理外のマルチロードバランサーを指定したなど、無効なマルチロードバランサーを指定した場合は、エラーが返されます。また、サーバーを指定するためには、サーバー名または、サーバーユニークIDが必要です。

指定するパラメーター

パラメーター 説明 必須 サンプル値
ElasticLoadBalancerId 対象のマルチロードバランサーユニークID
Type : String

(マルチロードバランサー名といずれか)
elb-8db04f81
ElasticLoadBalancerName 対象のマルチロードバランサー名
Type : String
使用可能文字 : 半角英数字(15文字)

(マルチロードバランサーユニークIDといずれか)
 
Protocol プロトコル
Type : String
値 : TCP | UDP | HTTP | HTTPS
 
ElasticLoadBalancerPort 待ち受けポート
Type : Integer
値 : 1〜65535の数値
 
InstancePort 宛先ポート
Type : Integer
値 : 1〜65535の数値
 
Instances.member.n.InstanceUniqueId サーバーユニークID
Type : String

(サーバー名といずれか)
i-a1b2c3d4
Instances.member.n.InstanceId サーバー名
Type : String

(サーバーユニークIDといずれか)
server02

応答フィールド

フィールド 説明 サンプル値
NiftyDeregisterInstancesFromElasticLoadBalancerResponse NiftyDeregisterInstancesFromElasticLoadBalancerレスポンス
Type : NiftyDeregisterInstancesFromElasticLoadBalancerResponse
Ancestor :なし
Children : NiftyDeregisterInstancesFromElasticLoadBalancerResult, ResponseMetadata
 
NiftyDeregisterInstancesFromElasticLoadBalancerResult 追加に成功したサーバー情報
Type : NiftyDeregisterInstancesFromElasticLoadBalancerResult
Ancestor : NiftyDeregisterInstancesFromElasticLoadBalancerResponse
Children : Instances
 
Instances 処理後の設定サーバーの情報
Type : InstanceUniqueIds
Ancestor : NiftyDeregisterInstancesFromElasticLoadBalancerResult
Children : member
 
member 処理後の設定サーバーの情報
Type : InstanceUniqueId
Ancestor : InstanceUniqueIds
Children : InstanceUniqueId、 InstanceId
 
InstanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
 
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : NiftyDeregisterInstancesFromElasticLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor :ResponseMetadata
Children : なし
ac501097-4c8d-475b-b06b-a90048ec181c

リクエストサンプル

https://jp-east-1.computing.api.nifcloud.com/api/?Action=NiftyDeregisterInstancesFromElasticLoadBalancer&ElasticLoadBalancerName=lb0001&Protocol=TCP&ElasticLoadBalancerPort=443&InstancePort=443&Instances.member.1.InstanceId=server02

応答サンプル

<NiftyDeregisterInstancesFromElasticLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
  <NiftyDeregisterInstancesFromElasticLoadBalancerResult>
    <Instances>
      <member>
        <InstanceUniqueId>i-a1b2c3d4e</InstanceUniqueId>
        <InstanceId>server03</InstanceId>
      </member>
    </Instances>
  </NiftyDeregisterInstancesFromElasticLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</NiftyDeregisterInstancesFromElasticLoadBalancerResponse> 

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

APIメニュー

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

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