ページの先頭行へ戻る
ServerView Resource Orchestrator Cloud Edition V3.1.1 リファレンスガイド (API編)
ServerView
第3章 課金APIリファレンス > 3.1 リソース使用量の操作 > 3.1.1 GetResourceUsage （リソース使用量を取得）
前次

3.1.1 GetResourceUsage （リソース使用量を取得）

リソース使用量を取得します。

リクエストパラメーター

パラメーター名

項目

項目説明

[version]

説明

課金APIのバージョンID

型

string ASCII

設定内容

"1.0"を指定してください。省略した場合は最新のバージョンで動作します。

action

説明

実行する課金APIの名称

型

string ASCII

設定内容

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

[startDate]

説明

取得する情報の開始日

型

string ASCII

設定内容

"yyyy-MM-dd "形式で指定してください。
endDateの翌日以降の日付、API実行日、およびそれより先の日付は指定できません。
省略した場合は、API実行時点の前日として動作します。

[endDate]

説明

取得する情報の終了日

型

string ASCII

設定内容

"yyyy-MM-dd "形式で指定してください。
startDate以前の日付、API実行日、およびそれより先の日付は指定できません。
省略した場合は、API実行時点の前日として動作します。

[lplatformId]

説明

指定したL-Platformの情報を取得

型

string ASCII

設定内容

複数指定する場合はパラメーターをそれぞれに指定します。

例) lplatformId=aaa&lplatformId=bbb&…

なお、"lplatformId"を指定した場合は、"tenantName"は指定できません(逆も同様)。

[tenantName]

説明

指定したテナントの情報を取得

型

string ASCII

設定内容

複数指定する場合はパラメーターをそれぞれに指定します。

例) tenantName=aaa&tenantName=bbb&…

なお、"lplatformId"を指定した場合は、"tenantName"は指定できません(逆も同様)。

[recordStatus]

説明

取得する配備、稼働時間情報の状態フラグ

型

string ASCII

設定内容

以下のどれかを指定します。複数指定できます。

・NORMAL
・WARNING
・ERROR

なお、省略した場合はNORMALとWARNINGだけ取得します。


レスポンス

《ステータスコード》

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

《XML》

<?xml version="1.0" encoding="UTF-8"?>
<GetResourceUsageResponse>
 <responseMessage>[メッセージ]</responseMessage>
 <responseStatus>[ステータス]</responseStatus>
 <version>[バージョン]</version>
 <systems date="[取得するデータの日付]">
  <system id="[L-Platform ID]" name="[L-Platform名]" tenantName="[管理元テナントのテナント名]" tenantDeleteDate="[管理元テナントの削除日]">
   <accountingItems>
    <accountingItem>
     <products>
      <product id="[商品ID]" category="[カテゴリーコード]" resource="[リソース識別子]" usageUnit="[課金単位]" unitPrice="[単価]" unitNum="[単位数]">
       <deploymentRecords>
        <record startTime="[開始時刻]" startEvent="[開始イベント]" endTime="[終了時刻]" endEvent="[終了イベント]" recordStatus="[状態フラグ]"/>
       </deploymentRecords>
      </product>
     </products>
    </accountingItem>
   </accountingItems>
   <servers>
    <server id="[L-Server ID]" name="[L-Server名]">
     <disks>
      <disk id="[ディスクID]" name="[ディスク名]">
      </disk>
     </disks>
     <images type="[イメージ情報の種類]">
      <image id="[イメージリソースID]">
      </image>
     </images> 
    </server>
   </servers>
  </system>
 </systems>
</GetResourceUsageResponse>

《要素》

要素名

項目

項目説明

GetResourceUsageResponse

説明

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

型

なし

出現回数

1

responseMessage

説明

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

型

string UTF-8

出現回数

1

responseStatus

説明

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

型

string ASCII

出現回数

1

version

説明

APIのバージョン

型

string ASCII

出現回数

1

systems

説明

L-Platform一覧のレスポンス情報を持つ要素。

date :取得するデータの日付。形式は"yyyy-MM-dd "。

型

なし

出現回数

1以上

system

説明

L-Platformテンプレート情報の一式

・id : L-Platform ID
・name : L-Platform名
・tenantName : 管理元テナントのテナント名
・tenantDeleteDate : 管理元テナントの削除日。
形式は"yyyy-MM-dd THH:mm:ss.SSSZ "。
例) 2012年4月1日0時0分00.000秒 タイムゾーン UTC+9:00の場合、 2012-04-01T00:00:00.000+0900

削除されていないテナントの場合は、空が返却されます。属性は省略されません。

型

なし

出現回数

0以上

servers

説明

L-Server一覧のレスポンス情報を持つ要素

型

string ASCII

出現回数

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

server

説明

L-Server情報の一式

・id : L-Server ID
・name：L-Server名

型

string UTF-8

出現回数

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

disks

説明

ディスク一覧のレスポンス情報を持つ要素

型

string ASCII

出現回数

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

disk

説明

ディスク情報の一式

・id : ディスクID
・name：ディスク名

型

string ASCII

出現回数

disksの数分(それぞれに対して0以上)

images

説明

イメージリソース一覧のレスポンス情報を持つ要素

type : イメージ情報の種類
以下の値です。

・snapshot : スナップショット

型

string ASCII

出現回数

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

image

説明

イメージリソース情報の一式
・id : イメージリソースID

型

string ASCII

出現回数

imagesの数分(それぞれに対して0以上)

accountingItems

説明

課金情報一覧のレスポンス情報を持つ要素

型

string ASCII

出現回数

system、server、disk、およびimageの数分(それぞれに対して0以上)

accountingItem

説明

課金情報の一式

型

string ASCII

出現回数

accountingItemsの数分(それぞれに対して1以上)

products

説明

商品情報一覧のレスポンス情報を持つ要素

型

string ASCII

出現回数

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

product

説明

商品情報の一式

・id : 商品ID (注1)
・category : カテゴリーコード (注1)
・resource : リソース識別子 (注1)
・usageUnit : 課金単位 (注1)
・unitPrice : 単価 (注1)
・unitNum : 単位数(個数、周波数、サイズ、etc) (注2)

注1)とりうる値は商品マスタの仕様に準じます。商品が登録されていない場合は、属性は省略されず、空を返却します。

注2)商品ごとに性能値などを返却します。
・template : 1 (固定)
・vm : 1 (固定)
・pm : 1 (固定)
・cpu : CPU個数
・cpu_clock : CPU周波数
・memory : メモリサイズ
・disk : ディスクサイズ
・sys_disk : ディスクサイズ
・snapshot : ディスクサイズ

型

string ASCII

出現回数

productsの数分(それぞれに対して0以上)

deploymentRecords

説明

配備時間の一式

型

string ASCII

出現回数

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

operationRecords

説明

稼働時間の一式

型

string ASCII

出現回数

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

record

説明

配備、稼働時間情報

・startTime : 開始時刻。形式は"HH :mm :ss.SSSZ"。
例）1時5分00.000秒 タイムゾーン UTC+9:00の場合、01:05:00.000+0900
・startEvent : 開始イベント (注)
・endTime : 終了時刻。形式は"HH :mm :ss.SSSZ"。
例）1時5分00.000秒 タイムゾーン UTC+9:00の場合、01:05:00.000+0900
・endEvent : 終了イベント (注)
・recordStatus : 状態フラグ。以下のどれかになります。
- NORMAL
- WARNING
- ERROR

注)詳細は、「3.1.1.1 イベント一覧」を参照してください。

型

string ASCII

出現回数

deploymentRecordsまたはoperationRecordsの数分(それぞれに対して0以上)


サンプルレスポンス

<?xml version="1.0" encoding="UTF-8"?>
<GetResourceUsageResponse>
 <responseMessage>PAPI00000 Process completed..</responseMessage>
 <responseStatus>SUCCESS</responseStatus>
 <version>1.0</version>
 <systems date="2012-01-01">
  <system id="Tenant1-IYHPD30VJ" name="lplatform001" tenantName="Tenant1" tenantDeleteDate="" ownerUserId="tenant_user_001">
   <accountingItems>
    <accountingItem>
     <products>
      <product id="PID-TMP-001" category="template" resource="template-135562b98d2" usageUnit="month" unitPrice="1000.000" unitNum="1">
       <deploymentRecords>
        <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
       </deploymentRecords>
      </product>
     </products>
    </accountingItem>
   </accountingItems>
   <servers>
    <server id="Tenant1-IYHPD30VJ-S-0001" name="server01">
     <accountingItems>
      <accountingItem>
       <products>
        <product id="PID-VIM-001" category="vm" resource="/VMHostPool" usageUnit="month" unitPrice="800.000" unitNum="1">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
        </product>
       </products>
      </accountingItem>
      <accountingItem>
       <products>
        <product id="PID-CPU-001" category="cpu" resource="/VMHostPool" usageUnit="hour" unitPrice="0.150" unitNum="2">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
         <operationRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD_RUNNING" endTime="10:29:59.999+0900" endEvent="STOP" recordStatus="NORMAL"/>
         </operationRecords>
        </product>
        <product id="PID-CLK-001" category="cpu_clock" resource="/VMHostPool" usageUnit="hour" unitPrice="0.100" unitNum="10">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
         <operationRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD_RUNNING" endTime="10:29:59.999+0900" endEvent="STOP" recordStatus="NORMAL"/>
         </operationRecords>
        </product>
       </products>
      </accountingItem>
      <accountingItem>
       <products>
        <product id="PID-MEM-001" category="memory" resource="/VMHostPool" usageUnit="hour" unitPrice="0.100" unitNum="40">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
         <operationRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD_RUNNING" endTime="02:29:59.999+0900" endEvent="CHANGE_PRICE" recordStatus="NORMAL"/>
         </operationRecords>
        </product>
       </products>
      </accountingItem>
      <accountingItem>
       <products>
        <product id="PID-MEM-001" category="memory" resource="/VMHostPool" usageUnit="hour" unitPrice="0.150" unitNum="40">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
         <operationRecords>
          <record startTime="02:30:00.000+0900" startEvent="CHANGE_PRICE" endTime="10:29:59.999+0900" endEvent="STOP" recordStatus="NORMAL"/>
         </operationRecords>
        </product>
       </products>
      </accountingItem>
      <accountingItem>
       <products>
        <product id="PID-SYS-001" category="sys_disk" resource="/StoragePool" usageUnit="month" unitPrice="1.000" unitNum="200">
         <deploymentRecords>
          <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
         </deploymentRecords>
        </product>
       </products>
      </accountingItem>
     </accountingItems>
     <disks>
      <disk id="Tenant1-IYHPD30VJ-D-0002" name="DISK01">
       <accountingItems>
        <accountingItem>
         <products>
          <product id="PID-DSK-001" category="disk" resource="VMStoragePool" usageUnit="month" unitPrice="1.000" unitNum="200">
           <deploymentRecords>
            <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
           </deploymentRecords>
          </product>
         </products>
        </accountingItem>
       </accountingItems>
      </disk>
      <disk id="Tenant1-IYHPD30VJ-D-0002" name="DISK02">
       <accountingItems>
        <accountingItem>
         <products>
          <product id="PID-DSK-002" category="disk" resource="VMStoragePool" usageUnit="month" unitPrice="1.000" unitNum="300">
           <deploymentRecords>
            <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
           </deploymentRecords>
          </product>
         </products>
        </accountingItem>
       </accountingItems>
      </disk>
     </disks>
     <images type="snapshot">
      <image id="Tenant1-IYHPD30VJ-SS-0001">
       <accountingItems>
        <accountingItem>
         <products>
          <product id="PID-SS-001" category="snapshot" resource="VMStoragePool" usageUnit="month" unitPrice="1.000" unitNum="300">
           <deploymentRecords>
            <record startTime="00:00:00.000+0900" startEvent="PERIOD" endTime="23:59:59.999+0900" endEvent="END" recordStatus="NORMAL"/>
           </deploymentRecords>
          </product>
         </products>
        </accountingItem>
       </accountingItems>
      </image>
     </images>
    </server>
   </servers>
  </system>
 </systems>
</GetResourceUsageResponse>

3.1.1.1 イベント一覧

No.

イベント名

発生イベント

イベント概要

配備時間

稼働時間

開始

終了

開始

終了

1

ADD

○

-

-

-

追加

2

DELETE

-

○

-

-

削除

3

START

-

-

○

-

開始

4

STOP

-

-

○

○

停止

5

CHANGE_PRICE

○

○

○

○

商品マスタの単価変更

6

CHANGE_NUM

○

○

○

○

CPU数、メモリ容量などの単数変更

7

CHANGE_TENANT

○

○

-

-

L-Platformの異動

8

CHANGE_OWNER

○

○

○

○

L-Platformの所有者変更

9

PERIOD

○

-(注)

○

-(注)

定期ログ

10

BEGIN

○

-

○

-

日の開始（PERIODがない場合に0:00:00.000に出力される）

11

END

-

○

-

○

日の終了（毎日23:59:59.999に出力される）

12

UNKNOWN_ADD

-

○

-

-

ADD-ADD-DELETEの場合、ADD-UNKNOWN_ADDとなる

13

UNKNOWN_DELETE

-

○

-

-

ADD-DELETE-DELETEの場合、UNKNOWN_DELETE-DELETEとなる

14

UNKNOWN_START

-

-

-

○

START-START-STOPの場合、START-UNKNOWN_STARTとなる

15

UNKNOWN_STOP

-

-

○

-

DELETE-STOPの場合、UNKNOWN_STOP-STOPとなる

16

UNKNOWN_CHANGE

○

-

-

-

DELETE-CHANGEの場合、UNKNOWN_CHANGE-CHANGEとなる

17

UNKNOWN_PERIOD

○

-

○

-

STOP-PERIOD(RUNNNING)の場合、UNKNOWN_PERIOD-PERIODとなる

(注): combineRecord=falseの場合は、"○"

前次
Copyright 2011-2013 FUJITSU LIMITED