ニフクラAPI (コンピューティング: NiftyDescribePerformanceChart)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

クラウドトップ>コンピューティング> API> NiftyDescribePerformanceChart

NiftyDescribePerformanceChart

処理概要

サーバー、ディスクパーティション、ロードバランサー、マルチロードバランサーの稼働状況を表示したチャートのデータを取得します。

対象サーバーが停止されている場合は、以下の情報を取得されません。
・CPU使用率
・メモリ使用率
・ディスク使用率
・ディスクパーティション使用率

チャート出力を期間指定しない場合、最新24時間の10分間隔のデータが返されます。

チャート出力を期間指定する場合、期間が7日間までなら30分間隔のデータ、それ以降は1日間隔のデータが返されます。

指定可能な開始日は、当月から５カ月前の月初日まで指定可能となります。

例. 2020/08/11 の場合、 2020/03/01 を開始日として指定できます。

指定するパラメーター

パラメーター

型

説明

必須

FunctionName

string

対象機能名
値:

Server (サーバー)
LoadBalancer (ロードバランサー)
LB (ロードバランサー)
DiskPartition (ディスクパーティション)
DP (ディスクパーティション)
ElasticLoadBalancer (マルチロードバランサー)
ELB (マルチロードバランサー)

○

ResourceName.n

string

対象リソース名

サーバー	形式 : サーバー名
ロードバランサー	形式 : ロードバランサー名:待受ポート
ディスクパーティション	形式 : サーバー名:パーティション
マルチロードバランサー	形式 : マルチロードバランサー名:プロトコル:待受ポート

○

FromDate

string

チャート出力開始日
形式 : yyyymmdd | yyyy-mm-dd | yyyy/mm/dd

ToDate

string

チャート出力終了日
形式 : yyyymmdd | yyyy-mm-dd | yyyy/mm/dd

DataType.n

string

チャート出力項目

サーバー	値 : all(すべて) \| cpu(CPU使用率) \| memory(メモリ使用率) \| volume(ディスク使用率) \| ping(ping応答) \| status(起動ステータス) \| network(ネットワーク転送量) Default :all(すべて)
ロードバランサー	値: all(すべて) \| network(ネットワーク転送量) Default :all(すべて)
ディスクパーティション	値: all(すべて) \| partition(パーティション使用率) Default : all(すべて)
マルチロードバランサー	値: all(すべて) \| network(ネットワーク転送量) Default :all(すべて)

値:
FunctionName=* の場合

all (すべて)

FunctionName=Server の場合

cpu (CPU使用率)
memory (メモリ使用率)
volume (ディスク使用率)
ping (ping応答)
status (起動ステータス)
network (ネットワーク転送量)

FunctionName=Server,LoadBalancer,LB,ElasticLoadBalancer,ELB の場合

network (ネットワーク転送量)

FunctionName=DiskPartition,DP の場合

partition (パーティション使用率)

ValueType

string

チャート出力タイプ
値:

1 (平均値)
2 (最大値)

Default: 1 (平均値)

応答フィールド

フィールド (項目)	型	説明
NiftyDescribePerformanceChartResponse	-	NiftyDescribePerformanceChartレスポンス
␣requestId	string	リクエスト識別子
␣functionName	string	チャート対象の機能名値: Server (サーバー) LoadBalancer (ロードバランサー) DiskPartition (ディスクパーティション) ElasticLoadBalancer (マルチロードバランサー)
␣valueType	string	チャート対象の出力タイプ備考: 返却値 1(平均値),2(最大値)
␣performanceChartSet	-	チャート情報セット
␣␣item	-	チャート情報
␣␣␣resourceName	string	チャート情報のリソース名
␣␣␣dataType	string	チャート情報の出力項目値: cpu (CPU使用率) memory (メモリ使用率) volume (ディスク使用率) network(in) (ネットワーク転送量(IN)) network(out) (ネットワーク転送量(OUT)) partition (パーティション使用率) ping (ping応答) status (起動ステータス)
␣␣␣dataSet	-	チャート出力結果セット
␣␣␣␣item	-	チャート出力結果
␣␣␣␣␣dateTime	string	チャート出力日時形式 : yyyy/mm/dd hh:mi:ss
␣␣␣␣␣value	string	チャート出力結果の値単位(dataType=cpu,memory,volume,partition): % 単位(dataType=network): Mbps 値: 0[dataType=ping] (応答なし) 1[dataType=ping] (応答あり) 0[dataType=status] (停止) 1[dataType=status] (起動)

リクエストサンプル

    https://jp-east-1.computing.api.nifcloud.com/api/
  ?Action=NiftyDescribePerformanceChart
  &FunctionName=Server
  &ResourceName.1=server01
  &ResourceName.2=server02
  &FromDate=20140224
  &ToDate=20140224
  &DataType.1=cpu
  &DataType.2=network
  &DataType.3=ping
  &DataType.4=status
  &ValueType=1
  &CommonParams

応答サンプル

    <NiftyDescribePerformanceChartResponse xmlns="https://computing.api.nifcloud.com/api/">
  <requestId>ac501097-4c8d-475b-b06b-a90048ec181c</requestId>
  <functionName>Server</functionName>
  <valueType>1</valueType>
  <performanceChartSet>
    <item>
      <resourceName>server01</resourceName>
      <dataType>cpu</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>5</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>10</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server01</resourceName>
      <dataType>network(in)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>10</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>15</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server01</resourceName>
      <dataType>network(out)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>20</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>25</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server01</resourceName>
      <dataType>ping</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>0</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>1</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server01</resourceName>
      <dataType>status</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>0</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>1</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server02</resourceName>
      <dataType>cpu</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>5</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>10</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server02</resourceName>
      <dataType>network(in)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>10</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>15</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server02</resourceName>
      <dataType>network(out)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>20</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>25</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server02</resourceName>
      <dataType>ping</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>0</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>1</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>server02</resourceName>
      <dataType>status</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:35:00</dateTime>
          <value>0</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:45:00</dateTime>
          <value>1</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
  </performanceChartSet>
</NiftyDescribePerformanceChartResponse>