ニフクラAPI (コンピューティング: DeregisterInstancesFromLoadBalancer)

DeregisterInstancesFromLoadBalancer

処理概要

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

ロードバランサーを指定するためには、ロードバランサー名・ポート番号が必要です。自分が所有していないロードバランサーを指定する場合は、「ニフクラID.ロードバランサー名」の形式で指定する必要があります。

またサーバーを指定するためには、サーバー名が必要です。自分が所有していないサーバーを指定する場合は、「ニフクラID.サーバー名」の形式で指定する必要があります。

指定するパラメーター

パラメーター	型	説明	必須
LoadBalancerName	string	ロードバランサー名	○
LoadBalancerPort	integer	待ち受けポート	○
InstancePort	integer	宛先ポート	○
Instances.member.n.InstanceId	string	サーバー名	○

応答フィールド

フィールド (項目)	型	説明
DeregisterInstancesFromLoadBalancerResponse	-	DeregisterInstancesFromLoadBalancerレスポンス
␣DeregisterInstancesFromLoadBalancerResult	-	処理結果の情報セット
␣␣Instances	-	解除したサーバーの情報セット
␣␣␣member	-	解除したサーバーの情報
␣␣␣␣InstanceId	string	サーバー名
␣␣␣␣InstanceUniqueId	string	サーバーユニークID
␣ResponseMetadata	-	リクエスト情報
␣␣RequestId	string	リクエスト識別子

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=DeregisterInstancesFromLoadBalancer
  &LoadBalancerName=lb0001
  &LoadBalancerPort=443
  &InstancePort=443
  &Instances.member.1.InstanceId=server02
  &CommonParams

  

応答サンプル

    <DeregisterInstancesFromLoadBalancerResponse xmlns="https://computing.api.nifcloud.com/api/">
  <DeregisterInstancesFromLoadBalancerResult>
    <Instances>
      <member>
        <InstanceId>server02</InstanceId>
        <InstanceUniqueId>i-abvf1234</InstanceUniqueId>
      </member>
    </Instances>
  </DeregisterInstancesFromLoadBalancerResult>
  <ResponseMetadata>
    <RequestId>ac501097-4c8d-475b-b06b-a90048ec181c</RequestId>
  </ResponseMetadata>
</DeregisterInstancesFromLoadBalancerResponse>