本文へジャンプします。

ニフティクラウド APIリファレンス

NiftyDescribePerformanceChart

処理概要

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

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

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

指定するパラメーター

パラメーター 説明 必須 サンプル値
FunctionName 対象機能名
Type : String
値 : Server(サーバー) | LoadBalancer(ロードバランサー) | LB(ロードバランサー) | DiskPartition(ディスクパーティション) | DP(ディスクパーティション) | ElasticLoadBalancer(マルチロードバランサー) | ELB(マルチロードバランサー)
 
ResourceName.n

対象リソース名
Type : String

サーバー 形式 : サーバー名
ロードバランサー 形式 : ロードバランサー名:待受ポート
ディスクパーティション 形式 : サーバー名:パーティション
マルチロードバランサー 形式 : マルチロードバランサー名:プロトコル:待受ポート
lb001:80
FromDate チャート出力開始日
Type : String
形式 : yyyymmdd | yyyy-mm-dd | yyyy/mm/dd
   
ToDate チャート出力終了日
Type : String
形式 : yyyymmdd | yyyy-mm-dd | yyyy/mm/dd
   
DataType.n

チャート出力項目
Type : String

サーバー 値 : all(すべて) | cpu(CPU使用率) | memory(メモリ使用率) | volume(ディスク使用率) | network(ネットワーク転送量)
ロードバランサー 値: all(すべて) | network(ネットワーク転送量) | ping(ping応答) | status(起動ステータス)
ディスクパーティション 値: all(すべて) | partition(パーティション使用率)
Default : all(すべて)
マルチロードバランサー 値: all(すべて) | network(ネットワーク転送量)
Default :all(すべて)
   
ValueType チャート出力タイプ
Type : String
値 : 1(平均値) | 2(最大値)
Default : 1(平均値)
   

応答フィールド

フィールド 説明 サンプル値
NiftyDescribePerformanceChartRespons NiftyDescribePerformanceChartレスポンス
Type : NiftyDescribePerformanceChartResponseType
Ancestor : なし
Children : requestId, functionName, valueType, performanceChartSet
 
requestId リクエスト識別子
Type : xsd:string
Ancestor : NiftyDescribePerformanceChartResponse
Children : なし
f6dd8353-eb6b-6b4fd32e4f05
functionName チャート対象の機能名
Type : xsd:string
値 : Server(サーバー) | LoadBalancer(ロードバランサー) | DiskPartition(ディスクパーティション) | ElasticLoadBalancer(マルチロードバランサー)
Ancestor : NiftyDescribePerformanceChartResponse
Children : なし
 
valueType チャート対象の出力タイプ
Type : xsd:string
値 : 1(平均値) | 2(最大値)
Ancestor : NiftyDescribePerformanceChartResponse
Children : なし
 
performanceChartSet チャート情報セット
Type : PerformanceChartSetType
Ancestor : NiftyDescribePerformanceChartResponse
Children : item
 
item チャート情報
Type : PerformanceChartItemType
Ancestor : performanceChartSet
Children : resourceName, dataType, dataSet
 
resourceName チャート情報のリソース名
Type : xsd:string
Ancestor : item
Children : なし
 
dataType チャート情報の出力項目
Type : xsd:string
値 : cpu(CPU使用率) | memory(メモリ使用率) | volume(ディスク使用率) | network(in)(ネットワーク転送量(IN)) | network(out)(ネットワーク転送量(OUT)) | partition(パーティション使用率) | ping(ping応答) | status(起動ステータス)
Ancestor : item
Children : なし
 
dataSet チャート出力結果セット
Type : DataSetType
Ancestor : item
Children : item
 
item チャート出力結果
Type : DataItemType
Ancestor : dataSet
Children : dateTime, value
 
dateTime チャート出力日時
Type : xsd:string
形式 : yyyy/mm/dd hh:mi:ss
Ancestor : item
Children : なし
 
value チャート出力結果の値
Type : xsd:string
Ancestor : item
Children : なし
 

リクエストサンプル

サーバー情報の取得
https://cp.cloud.nifty.com/api/?Action=NiftyDescribePerformanceChart&FunctionName=Server&ResourceName.1=server01&ResourceName.2=server02&DataType.1=cpu&DataType.2=network&DataType.3=ping&DataType.4=status&CommonParams
ロードバランサー情報の取得
https://cp.cloud.nifty.com/api/?Action=NiftyDescribePerformanceChart&FunctionName=LoadBalancer&ResourceName.1=lb001%3A80&FromDate=20140221&ToDate=20140224&ValueType=1&CommonParams
ディスクパーティション情報の取得
https://cp.cloud.nifty.com/api/?Action=NiftyDescribePerformanceChart&FunctionName=DiskPartition&ResourceName.1=server01%3A%2Fmnt%2Faaa&ResourceName.2=server02%3A%2Fmnt%2Fbbb&DataType.1=all&CommonParams

応答サンプル

サーバー情報の取得
<NiftyDescribePerformanceChartResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</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>
ロードバランサー情報の取得
<NiftyDescribePerformanceChartResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <functionName>LoadBalancer</functionName>
  <valueType>1</valueType>
  <performanceChartSet>
    <item>
      <resourceName>lb001:80</resourceName>
      <dataType>network(in)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:00:00</dateTime>
          <value>10</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:30:00</dateTime>
          <value>15</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
    <item>
      <resourceName>lb001:80</resourceName>
      <dataType>network(out)</dataType>
      <dataSet>
        …(中略)…
        <item>
          <dateTime>2014/2/24 11:00:00</dateTime>
          <value>20</value>
        </item>
        <item>
          <dateTime>2014/2/24 11:30:00</dateTime>
          <value>25</value>
        </item>
        …(中略)…
      </dataSet>
    </item>
  </performanceChartSet>
</NiftyDescribePerformanceChartResponse>
ディスクパーティション情報の取得
<NiftyDescribePerformanceChartResponse xmlns="https://cp.cloud.nifty.com/api/">
  <requestId>f6dd8353-eb6b-6b4fd32e4f05</requestId>
  <functionName>DiskPartition</functionName>
  <valueType>1</valueType>
  <performanceChartSet>
    <item>
      <resourceName>server01:/mnt/aaa</resourceName>
      <dataType>partition</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:/mnt/bbb</resourceName>
      <dataType>partition</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>
  </performanceChartSet>
</NiftyDescribePerformanceChartResponse>

ニフティクラウド サイト内検索

APIメニュー

  • ツイッターでフォローしてください
  • ニフティクラウド公式フェイスブックページ

推奨画面サイズ 1024×768 以上