ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.0 リファレンスガイド (API編)
ServerView

2.2.16 UpdateSLBConfiguration(サーバロードバランサーの設定変更)

サーバロードバランサーの設定を変更します。

設定を変更しないパラメーターは省略することができます。

このAPIはPOSTメソッドだけサポートしています。

リクエストボディ

《XML》

<Request>
  <param name="Version">[バージョンID]</param>
  <param name="Locale">[ロケールID]</param>
  <param name="Action">[アクションID]</param>
  <param name="userId">[ユーザーID]</param>
  <param name="orgId">[テナントID]</param>
  <param name="lplatformId">[L-Platform ID]</param>
  <Body>
    <slb>
      <name>[サーバロードバランサー名]</name>
      <ruleset>
        <parameters>
          <parameter>
            <name>[パラメーター名]</name>
            <value>[パラメーター値]</value>
          </parameter>
          …
        </parameters>
      </ruleset>
    </slb>
  </Body>
</Request>

《パラメーター》

パラメーター名

項目

項目説明

Version

説明

L-Platform APIのバージョンID

string ASCII

設定内容

固定。"2.0"を指定してください。

Locale

説明

L-Platform APIと通信するための言語。ISO 639で規定されている言語コードを指定します。

string ASCII

設定内容

以下から選択します。
・"ja": 日本語
・"en": 英語

Action

説明

実行するL-Platform APIの名称

string ASCII

設定内容

固定。"UpdateSLBConfiguration"を指定してください。

userId

説明

L-Platform APIを実行するユーザーID

string ASCII

設定内容

31文字以内

orgId

説明

L-Platform APIを実行するユーザーのテナント名

string ASCII

設定内容

32文字以内

L-Platform ID

説明

L-PlatformのID

string ASCII

設定内容

32文字以内

サーバロードバランサー名

説明

サーバロードバランサーの名前

string ASCII

設定内容

32文字以内

パラメーター名

説明

変更するパラメーターの名前。
GetLPlatformConfigurationで取得した対象のサーバロードバランサー配下にある、パラメーターの名前を指定してください。
画面に表示される名前とは異なる場合があります。

string ASCII

設定内容

< > & ‘ “ および改行は指定できません。

パラメーターの値

説明

変更後のパラメーターの値

string ASCII

設定内容

< > & ‘ “ および改行は指定できません。


レスポンス

《ステータスコード》

正常に終了した場合に"200 OK"を返します。

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<UpdateSLBConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
</UpdateSLBConfigurationResponse>

《要素》

要素名

項目

項目説明

UpdateSLBConfigurationResponse

説明

レスポンスの情報を持つ要素

なし

出現回数

1

responseMessage

説明

メッセージ。リクエストが正しく処理されたかどうかを表します。
メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。

string UTF-8

出現回数

1

responseStatus

説明

ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。
エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧(L-Platform API)」を参照してください。

string ASCII

出現回数

1


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<UpdateSLBConfigurationResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</UpdateSLBConfigurationResponse>