Cisco ACNS ソフトウェア API ガイド Release 5.5
統計情報 API
統計情報 API
発行日;2012/01/11 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 539KB) | フィードバック

目次

統計情報 API

モニタリング統計情報 API

モニタリング統計情報 API 動作

getCeStats

getLocationStats

getCdnStats

ストリーミング統計情報 API

ストリーミング統計情報 API の動作

getHttp

getCiscoStreaming

getWmt

getRealProxy

XML 形式の出力

統計情報 API

この章では、モニタリング統計情報 API とストリーミング統計情報 API、およびこれらの API が実行する servlet 動作について説明します。この章の構成は、次のとおりです。

「モニタリング統計情報 API」

「ストリーミング統計情報 API」

モニタリング統計情報 API

ここでは、モニタリング統計情報 API およびこの API が実行する servlet 動作について説明します。モニタリング統計情報 API は、1 つの Content Engine または ACNS ネットワーク内のすべての Content Engine に関するモニタリング統計情報のデータを取得します。

モニタリング統計情報 API 動作

モニタリング統計情報 API は、MonitoringApiServlet と記述します。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.MonitoringApiServlet...

この servlet は、次の動作の 1 つまたは複数を実行します。

getCeStats

getLocationStats

getCdnStats

getCeStats

指定の Content Engine に関するモニタリング統計情報を取得します。

パラメータ

Content Engine ID(必須)

モニタリング統計情報のタイプ(必須)

モニタリング統計情報のタイプは次のとおりです。

bytes_served

bandwidth_efficiency_gain

streaming_sessions

cpu_utilization

Time frame(時間フレーム)(任意) -- モニタリング統計情報を取得する期間。デフォルトは last_hour です。

オプションは次のとおりです。

last_hour

last_day

last_week

last_month

custom


) custom を選択した場合は、End time from オプションと End time to オプションを使用して、時間フレームを指定する必要があります。


End time from(開始時)(任意) -- モニタリング統計情報のデータ収集を開始する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

End time to(終了時)(任意) -- モニタリング統計情報のデータ収集を終了する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

Time zone(時間帯)(任意) -- モニタリング統計情報のデータを生成するために使用される時間帯。デフォルトは utc です。

時間帯は次のとおりです。

utc -- 世界標準時(UTC)で表す時刻

ce_local_time -- Content Engine 上に指定される時間帯

cdm_local_time -- Content Distribution Manager 上に指定される時間帯

結果

指定の期間中の Content Engine のモニタリング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.MonitoringApiServlet?action=getCeStats&id=<CeConfig_id>&type=<bytes_served | bandwidth_efficiency_gain | streaming_sessions | cpu_utilization>[&time_frame=<last_hour | last_day | last_week | last_month | custom>][&end_time_from=<mm/dd/yyyy [hh:mm[:ss]]>][&end_time_to=<mm/dd/yyyy [hh:mm[:ss]]>][&time_zone=<utc | ce_local_time | cdm_local_time>]

getLocationStats

指定のロケーション内のすべての Content Engine のモニタリング統計情報を取得します。

パラメータ

ロケーション ID(必須)

モニタリング統計情報のタイプ(必須)

モニタリング統計情報のタイプは次のとおりです。

bytes_served

bandwidth_efficiency_gain

streaming_sessions

Time frame(時間フレーム)(任意) -- モニタリング統計情報を取得する期間デフォルトは last_hour です。

オプションは次のとおりです。

last_hour

last_day

last_week

last_month

custom


) custom を選択した場合は、End time from オプションと End time to オプションを使用して、時間フレームを指定する必要があります。


End time from(開始時)(任意) -- モニタリング統計情報のデータ収集を開始する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

End time to(終了時)(任意) -- モニタリング統計情報のデータ収集を終了する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

Time zone(時間帯)(任意) -- モニタリング統計情報のデータを生成するために使用される時間帯。デフォルトは utc です。

時間帯は次のとおりです。

utc -- 世界標準時(UTC)で表す時刻

cdm_local_time -- Content Distribution Manager 上に指定される時間帯

結果

期間を指定して要求された、指定のロケーション内の Content Engine のモニタリング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.MonitoringApiServlet?action=getLocationStats&id=<Location_id>&type=<bytes_served | bandwidth_efficiency_gain | streaming_sessions>[&time_frame=<last_hour | last_day | last_week | last_month | custom>][&end_time_from=<mm/dd/yyyy [hh:mm[:ss]]>][&end_time_to=<mm/dd/yyyy [hh:mm[:ss]]>][&time_zone=<utc | cdm_local_time>]

getCdnStats

ACNS ネットワーク全体のモニタリング統計情報を取得します。

パラメータ

モニタリング統計情報のタイプ(必須)

モニタリング統計情報のタイプは次のとおりです。

bytes_served

bandwidth_efficiency_gain

streaming_sessions

Time frame(時間フレーム)(任意) -- モニタリング統計情報を取得する期間デフォルトは last_hour です。

オプションは次のとおりです。

last_hour

last_day

last_week

last_month

custom


) custom を選択した場合は、End time from オプションと End time to オプションを使用して、時間フレームを指定する必要があります。


End time from(開始時)(任意) -- モニタリング統計情報のデータ収集を開始する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

End time to(終了時)(任意) -- モニタリング統計情報のデータ収集を終了する日付と時刻。日付のみ、または日付と時刻の両方を指定できます。日付形式は mm/dd/yyyy、時刻形式は hh:mm です。時刻形式は hh:mm:ss を任意で指定できます。

Time zone(時間帯)(任意) -- モニタリング統計情報のデータを生成するために使用される時間帯。デフォルトは utc です。

時間帯は次のとおりです。

utc -- 世界標準時(UTC)で表す時刻

cdm_local_time -- Content Distribution Manager 上に指定される時間帯

結果

期間を指定して要求された、ACNS ネットワーク内の全 Content Engine のモニタリング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.MonitoringApiServlet?action=getCdnStats&type=<bytes_served | bandwidth_efficiency_gain | streaming_sessions>[&time_frame=<last_hour | last_day | last_week | last_month | custom>][&end_time_from=<mm/dd/yyyy [hh:mm[:ss]]>][&end_time_to=<mm/dd/yyyy [hh:mm[:ss]]>][&time_zone=<utc | cdm_local_time>]

ストリーミング統計情報 API

ここでは、ストリーミング統計情報 API およびこの API が実行する servlet 動作について説明します。ストリーミング統計情報は ACNS ネットワーク内の Content Engine とデバイス グループから収集され、Content Distribution Manager に送信されます。HTTP、Cisco Streaming Engine、WMT、および RealProxy のストリーミング統計情報のデータがモニタリングされ、すべての Content Engine、すべてのデバイス グループ、または選択されたデバイス グループ内のすべての Content Engine のストリーミング統計情報のデータが Content Distribution Manager の GUI に表示されます。

ストリーミング統計情報 API の動作

ストリーミング統計情報 API は、SprayerApiServlet と記述されます。servlet が機能するには、Content Distribution Manager とその GUI が稼働している必要があります。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.SprayerApiServlet...

この servlet は、次の動作の 1 つまたは複数を実行して、Content Engine(CE)、デバイス グループ(DG)、または指定されたデバイス グループ内のすべての Content Engine のデバイス グループ名ごとに統計情報のデータを収集します。

getHttp

getCiscoStreaming

getWmt

getRealProxy

getHttp

HTTP ストリーミング統計情報のデータを ACNS ネットワーク内の Content Engine とデバイス グループから収集し、Content Distribution Manager に送信します。

パラメータ

キーワード(CE、DG)またはデバイス グループ名が必要です。

結果

要求された Content Engine またはデバイス グループのストリーミング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.SprayerApiServlet?action=getHttp&
param=CE | DG | <DG_name>, <DG_name>, ...

getCiscoStreaming

Cisco Streaming Engine のストリーミング統計情報データを ACNS ネットワーク内の Content Engine とデバイス グループから収集し、Content Distribution Manager に送信します。

パラメータ

キーワード(CE、DG)またはデバイス グループ名が必要です。

結果

要求された Content Engine またはデバイス グループ用ストリーミング統計データ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.SprayerApiServlet?action=getCiscoStreaming&param=CE | DG | <DG_name>, <DG_name>, ...

getWmt

WMT ストリーミング統計情報のデータを ACNS ネットワーク内の Content Engine とデバイス グループから収集し、Content Distribution Manager に送信します。

パラメータ

キーワード(CE、DG)またはデバイス グループ名が必要です。

結果

要求された Content Engine またはデバイス グループのストリーミング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.SprayerApiServlet?action=getWmt&param=CE | DG | <DG_name>, <DG_name>, ...

getRealProxy

RealProxy ストリーミング統計情報のデータを ACNS ネットワーク内の Content Engine とデバイス グループから収集し、Content Distribution Manager に送信します。

パラメータ

キーワード(CE、DG)またはデバイス グループ名が必要です。

結果

要求された Content Engine またはデバイス グループのストリーミング統計情報のデータ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.SprayerApiServlet?action=getRealProxy&param=CE | DG | <DG_name>, <DG_name>, ...

XML 形式の出力

次の例は、XML 形式による出力の Document Type Definition(DTD)です。

<?xml version="1.0" ?>
DOCTYPE <!DOCTYPE sprayerStats [
 
<!ELEMENT sprayerStats (message, (HttpStats* | CiscoStreamingEngineStats* | RealProxyStats | WmtStats*) )>
<!ATTLIST sprayerStats
action (getHttp | getCiscoStreaming | getRealProxy | getWmt)#REQUIRED
count CDATA #REQUIRED>
 
<!ELEMENT message EMPTY>
<!ATTLIST message
status (success | fail) success
message CDATA #IMPLIED>
 
<!ELEMENT HttpStats EMPTY>
<!ATTLIST HttpStats
name CDATA #REQUIRED
requestsPerSec CDATA #REQUIRED
bytesPerSec CDATA #REQUIRED
serviceTime CDATA #REQUIRED
hitRate CDATA #REQUIRED>
 
<!ELEMENT CiscoStreamingEngineStats EMPTY>
<!ATTLIST CiscoStreamingEngineStats
name CDATA #REQUIRED
totalBytes CDATA #REQUIRED
totalPackets CDATA #REQUIRED
rtspConnections CDATA #REQUIRED
allConnections CDATA #REQUIRED>
 
<!ELEMENT RealProxyStats EMPTY>
<!ATTLIST RealProxyStats
name CDATA #REQUIRED
requestsPerSec CDATA #REQUIRED
bytesPerSec CDATA #REQUIRED
hitRate CDATA #REQUIRED>
 
<!ELEMENT WmtStats EMPTY>
<!ATTLIST WmtStats
name CDATA #REQUIRED
requestsPerSec CDATA #REQUIRED
bytesPerSec CDATA #REQUIRED
hitRate CDATA #REQUIRED>
 
]>