2.2.17 OperateSLB(サーバロードバランサーの運用操作)

サーバロードバランサーの運用操作を実行します。

未取得の運用操作ログが存在する場合は、運用操作を行うことはできません。

ルールセットに定義されているすべてのパラメーターを指定する必要があります。

この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>
        <name>[ルールセット名]</name>
        <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
	設定内容	固定。"OperateSLB"を指定してください。
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文字以内
ルールセット名	説明	ルールセットの名前
	型	string ASCII
	設定内容	32文字以内
パラメーター名	説明	運用操作を実行するサーバロードバランサーのパラメーターの名前。 GetRulesetConfigurationで取得した対象のルールセット配下にある、パラメーターの名前を指定してください。画面に表示される名前とは異なる場合があります。
	型	string ASCII
	設定内容	< > & ‘ “ および改行は指定できません。
パラメーターの値	説明	運用操作を実行するパラメーターの値
	型	string ASCII
	設定内容	< > & ‘ “ および改行は指定できません。

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<OperateSLBResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <operationId>[運用操作のID]</operationId>
</OperateSLBResponse>

《要素》

要素名	項目	項目説明
OperateSLBResponse	説明	レスポンスの情報を持つ要素
	型	なし
	出現回数	1
responseMessage	説明	メッセージ。リクエストが正しく処理されたかどうかを表します。メッセージの詳細については、「メッセージ集」の「第16章 PAPIで始まるメッセージ」を参照してください。
	型	string UTF-8
	出現回数	1
responseStatus	説明	ステータス。リクエストが正常に処理されたかどうかを表します。正常に処理された場合は "SUCCESS" が返却されます。それ以外の場合はエラーコードが返却されます。エラーコードの詳細については、「付録A レスポンスステータス・エラーコード一覧（L-Platform API）」を参照してください。
	型	string ASCII
	出現回数	1
operationId	説明	運用操作のID。 GetOperationResult実行時に指定します。
	型	string ASCII
	出現回数	1

サンプルレスポンス

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