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

2.3.22 UpdateIPAddress (サーバのIPアドレスを更新)

サーバに割り当てられているIPアドレスを更新します。

本APIは、非同期で実行されます。本APIの実行に成功すると、処理の実行中はL-Platformの状態が構成変更中(RECONFIG_ING)に遷移し、処理が完了すると、L-Platformの状態が正常稼働中(NORMAL)に戻ります。
L-Platformの状態が構成変更中の場合は、L-Platformに対する操作ができません。
L-Platformの状態をGetLPlatformStatusで監視し、正常稼働中に遷移するのを待ってから次の操作を行ってください。

以下の場合、本APIは実行できません。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

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

userId

説明

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

string ASCII

設定内容

31文字以内

orgId

説明

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

string ASCII

設定内容

32文字以内

lplatformId

説明

L-Platform ID

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

string ASCII

設定内容

32文字以内

nicNo

説明

NIC連番

int

設定内容

1以上。更新するIPアドレスのNIC連番を指定してください。

ipAddress

説明

IPアドレス

string ASCII

設定内容

更新後のIPアドレスを指定してください。


レスポンス

《ステータスコード》

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


《XML》

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

《要素》

要素名

項目

項目説明

UpdateIPAddressResponse

説明

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

なし

出現回数

1

responseMessage

説明

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

string UTF-8

出現回数

1

responseStatus

説明

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

string ASCII

出現回数

1


サンプルレスポンス

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