ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.0.0 リファレンスガイド インフラ管理者編
第3部 APIリファレンス > 第7章 L-Platform API > 7.3 L-Platform APIリファレンス > 7.3.4 増設ディスクの操作
前次

7.3.4 増設ディスクの操作

増設ディスクの操作に関連するL-Platform APIについて説明します。

7.3.4.1 CreateDisk (増設ディスクを追加)

サーバに新規の拡張ディスクを取り付けます。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「CreateDisk」を指定してください。

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文字以内

diskSize

説明

取り付ける拡張ディスクサイズ。「GB」単位で小数点第一位まで指定できます。

型

decimal

設定内容

0.1～99999.9

diskName

説明

取り付ける拡張ディスクの名前

型

string UTF-8

設定内容

85文字以内

[storagePool]

説明

拡張ディスクを作成するストレージプールのリソース名

型

string ASCII

設定内容

テナントのプールを利用する場合、プール名はフルパスで指定する必要があります。

例：/tenantA/pool


コマンド

CreateDisk -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -diskSize 拡張ディスクサイズ
 -diskName 拡張ディスクの名前 [-storagePool ストレージプールのリソース名]

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<CreateDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <diskId>[作成されたディスクID]</diskId>
</CreateDiskResponse>

《要素》

要素名

項目

項目説明

CreateDiskResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

diskId

説明

この操作により作成されたディスクID

型

string ASCII

出現回数

0または1


サンプルレスポンス

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

7.3.4.2 DestroyDisk (増設ディスクを削除)

サーバに取り付けられている拡張ディスクを取り外します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「DestroyDisk」を指定してください。

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文字以内

diskId

説明

取り外す拡張ディスクID

型

string ASCII

設定内容

32文字以内


コマンド

DestroyDisk -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -diskId 拡張ディスクID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DestroyDiskResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

7.3.4.3 ListDisk (既存ディスクの一覧を取得)

既存ディスクの一覧を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「ListDisk」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内


コマンド

ListDisk -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード -orgId テナント名

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<ListDiskResponse>
 <responseMessage>[メッセージ]</responseMessage>
 <responseStatus>[ステータス]</responseStatus>
 <disks>
  <disk>
   <resourceName>[既存ディスク名]</resourceName>
   <diskResourceId>[既存ディスクのリソースID]</diskResourceId>
   <label>[既存ディスクラベル]</label>
   <comment>[既存ディスクのコメント]</comment>
   <diskSize>[既存ディスクサイズ]</diskSize>
   <storagePool>[ストレージプールのリソース名]</storagePool>
   <preCreated>[事前切り出し属性]</preCreated>
   <status>[既存ディスクのステータス]</status>
  </disk>
 </disks>
</ListDiskResponse>

《要素》

要素名

項目

項目説明

ListDiskResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

disks

説明

既存ディスク情報のレスポンス情報を持つ要素

型

なし

出現回数

0または1

disk

説明

既存ディスク情報の一式

型

なし

出現回数

0以上

resourceName

説明

既存ディスク名

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

diskResourceId

説明

既存ディスクのリソースID

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

label

説明

既存ディスクラベル

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

comment

説明

既存ディスクのコメント

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

diskSize

説明

既存ディスクサイズ。「GB」単位で指定します。

型

decimal

出現回数

diskの数分(それぞれに対して0または1)

storagePool

説明

ストレージプールのリソース名

型

string UTF-8

出現回数

diskの数分(それぞれに対して0または1)

preCreated

説明

事前切り出し属性

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)

status

説明

既存ディスクのステータス

型

string ASCII

出現回数

diskの数分(それぞれに対して0または1)


サンプルレスポンス

<?xml version=”1.0” encoding=”UTF-8”?>
<ListDiskResponse>
 <responseMessage>PAPI00000 Processing was completed.</responseMessage>
 <responseStatus>SUCCESS</responseStatus>
 <disks>
  <disk>
   <name>small-disk</name>
   <diskResourceId>disk-1241</diskResourceId>
   <label>disk-0001</label>
   <comment>comment</comment>
   <size>30.0</size>
   <storagePool>/StoragePool</storagePool>
   <status>normal</status>
  </disk>
 </disks>
</ListDiskResponse>

7.3.4.4 AttachDisk (既存ディスクの取り付け)

サーバに既存の拡張ディスクを取り付けます。

取り付ける既存ディスクの一覧はListDiskで取得してください。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「AttachDisk」を指定してください。

userId

説明

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

型

string ASCII

設定内容

31文字以内

orgId

説明

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

型

string ASCII

設定内容

32文字以内

lplatformId

説明

システムID

型

string ASCII

設定内容

32文字以内

lserverId

説明

サーバID

型

string ASCII

設定内容

32文字以内

diskResourceId

説明

取り付ける既存ディスクのリソースID

型

string ASCII

設定内容

32文字以内

diskName

説明

取り付ける既存ディスクの表示名

型

string UTF-8

設定内容

85文字以内。既存ディスクの名前を指定する必要はありません。


コマンド

AttachDisk -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -diskResourceId 既存ディスクのリソースID
 -diskName 取り付ける既存ディスクの表示名

レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<AttachDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[メッセージ]</responseMessage>
  <responseStatus>[ステータス]</responseStatus>
  <diskId>[作成されたディスクID]</diskId>
</AttachDiskResponse>

《要素》

要素名

項目

項目説明

AttachDiskResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

diskId

説明

この操作により作成されたディスクのID

型

string ASCII

出現回数

0または1


サンプルレスポンス

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

7.3.4.5 DetachDisk (既存ディスクの取り外し)

サーバに取り付けられている拡張ディスクを取り外します。

リクエストパラメーター

パラメーター名

項目

項目説明

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

設定内容

固定。「DetachDisk」を指定してください。

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文字以内

diskId

説明

取り外す拡張ディスクID

型

string ASCII

設定内容

32文字以内


コマンド

DetachDisk -version バージョンID -locale 言語コード -userId ユーザーID -password パスワード
 -orgId テナント名 -lplatformId L-Platform ID -lserverId サーバID -diskId 拡張ディスクID

レスポンス

《ステータスコード》

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

《XML》

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

《要素》

要素名

項目

項目説明

DetachDiskResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1


サンプルレスポンス

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

前次
Copyright 2011-2012 FUJITSU LIMITED