本文へジャンプします。

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

RegisterInstancesWithLoadBalancer

処理概要

指定したロードバランサーにサーバーを追加します。

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

またサーバーを指定するためには、サーバー名が必要です。IPアドレスを固定化しているサーバーを指定できます。IPアドレスを固定化していないサーバーを指定した、削除済みのサーバーを指定した、共有を許可していない管理外のサーバーを指定したなど、無効なサーバーを指定した場合は、エラーが返されます。

指定するパラメーター

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

応答フィールド

フィールド(項目) 説明 サンプル値
RegisterInstances
WithLoadBalancerResponse
RegisterInstancesWithLoadBalancer レスポンス
Type : RegisterInstancesWithLoadBalancerResponse
Ancestor : なし
Children : RegisterInstancesWithLoadBalancerResult, ResponseMetadata
 
RegisterInstances
WithLoadBalancerResult
処理結果の情報セット
Type : RegisterInstancesWithLoadBalancerResult
Ancestor : RegisterInstancesWithLoadBalancerResponse
Children : Instances
 
Instances 追加に成功したサーバーの情報セット
Type : InstanceUniqueIds
Ancestor : RegisterInstancesWithLoadBalancerResult
Children : member
 
member 追加に成功したサーバーの情報
Type : InstanceUnique
Ancestor : Instances
Children : InstanceId, InstanceUniqueId
 
InstanceId サーバー名
Type : xsd:string
Ancestor : member
Children : なし
server02
instanceUniqueId サーバーユニークID
Type : xsd:string
Ancestor : member
Children : なし
i-asda1234
ResponseMetadata リクエスト情報
Type : ResponseMetadata
Ancestor : RegisterInstancesWithLoadBalancerResponse
Children : RequestId
 
RequestId リクエスト識別子
Type : xsd:string
Ancestor : ResponseMetadata
Children : なし
f6dd8353-eb6b-6b4fd32e4f05

リクエストサンプル

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

応答サンプル

<RegisterInstancesWithLoadBalancerResponse xmlns="https://cp.cloud.nifty.com/api/">
 <RegisterInstancesWithLoadBalancerResult>
  <Instances>
   <member>
    <InstanceId>server02</InstanceId>
    <instanceUniqueId>i-asda1234</instanceUniqueId>
   </member>
  </Instances>
 </RegisterInstancesWithLoadBalancerResult>
 <ResponseMetadata>
  <RequestId>f6dd8353-eb6b-6b4fd32e4f05</RequestId>
 </ResponseMetadata>
</RegisterInstancesWithLoadBalancerResponse>

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

APIメニュー

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

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