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

目次

リスト表示 API

リスト表示 API の動作

getWebSites

getChannels

getCEs

getClusters

getContentProviders

getLocations

getDeviceGroups

getDeviceStatus

getObjectById

getObjectByName

getPrograms

getPgmMcastAddrInUse

getMcastAddrInUse

getPgmMcastAddrRange

リスト表示 API

この章では、リスト表示 API およびこの API が実行する servlet 動作について説明します。

リスト表示 API の動作

リスト表示 API は、ListingApiServlet と記述します。オブジェクト内にリストがあると、リスト アイテムはオブジェクトの要素として印刷されます。

構文

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

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

getWebSites

getChannels

getCEs

getClusters

getContentProviders

getLocations

getDeviceGroups

getDeviceStatus

getObjectById

getObjectByName

getPrograms

getPgmMcastAddrInUse

getMcastAddrInUse

getPgmMcastAddrRange

getWebSites

選択された Web サイト名と関連コンテンツ プロバイダー名、またはすべての Web サイトをリスト表示します。

パラメータ

Web サイト名のリストまたはキーワード all のいずれかが必須

結果

指定されたすべての Web サイトとその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action= getWebSites&param=all | <website_name>, <website_name>,...

getChannels

選択されたチャネル名および関連する Web サイト ID、またはすべてのチャネルをリスト表示します。

パラメータ

チャネル名および関連する Web サイト ID、Content Engine ID、プログラム ID のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべてのチャネルとその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getChannels&param=all | [name=]<website_ID>:all | <channel_name> ... | ce=<ceConfig_ID> | program=<playlist_ID>

getCEs

選択された Content Engine を Content Engine の名前、チャネル、ロケーション別にリスト表示するか、またはすべての Content Engine をリスト表示します。Content Engine がロケーション別にリスト表示される場合、指定のロケーションにあるすべての Content Engine とその従属ロケーションにあるすべての Content Engine(子、孫など)がリスト表示されます。

パラメータ

Content Engine 名、チャネル ID、ロケーション ID のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべての Content Engine とその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getCEs&param=all | [name=]<ce_name>, <ce_name> ... | channel=<channel_ID> | location=<location_ID>

getClusters

選択されたクラスタ名、またはすべてのクラスタをリスト表示します。

パラメータ

クラスタ ID のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべてのクラスタとその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action= getClusters&param=all | <Cluster_ID>, <Cluster_ID>...

getContentProviders

選択されたコンテンツ プロバイダー名、またはすべてのコンテンツ プロバイダーをリスト表示します。

パラメータ

コンテンツ プロバイダー名のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべてのコンテンツ プロバイダーとその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getContentProviders&param=all | <content_provider_name>, <content_provider_name>...

getLocations

指定の Content Engine のロケーション、またはすべての Content Engine のロケーションをリスト表示します。

パラメータ

Content Engine ID のリスト、またはキーワード all のいずれかが必須

結果

要求されたロケーション レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getLocations&param=all | byCeId=<CE_ID>

getDeviceGroups

選択されたデバイス グループ名、またはすべてのデバイス グループをリスト表示します。

パラメータ

デバイス グループ名のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべての Device Group とその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action= getDeviceGroups&param=all | <device_group_name>, <device_group_name>,...

getDeviceStatus

デバイスの状況を名前別にリスト表示します。

パラメータ

デバイスまたはデバイス グループの ID を含むデバイス名パラメータを指定しない場合、すべてのデバイスの状況が返されます。


) デバイス名には、大文字と小文字の区別があります。


結果

デバイスのリストとその状況

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.DeviceApiServlet?action=getDeviceStatus[&name=<device_ID> | <deviceGroup_ID>]

getObjectById

ストリング ID に基づき、オブジェクトをリスト表示します。

パラメータ

オブジェクト ストリング ID

オブジェクト タイプは次のとおりです。

CE

チャネル

クラスタ

CP

デバイス グループ

Web サイト

プログラム

結果

要求されたオブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action= getObjectById&param=<CeConfig_X | Channel_X | ClusterConfig_X | ContentProvider_X | DeviceGroup_X | WebSite_X | Playlist_X>


) この動作を実行するには、管理者レベルのアクセス権限が必要です。


getObjectByName

オブジェクト名に基づき、オブジェクトをリスト表示します。

パラメータ

オブジェクト タイプ:オブジェクト名

オブジェクト タイプは次のとおりです。

CE

チャネル

CP

DG

Web サイト

プログラム

チャネル名の形式は、「Web サイト名:チャネル名」です。

結果

要求されたオブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action= getObjectByName&param=CE:<ceName> | Channel:<websiteName:channelName> | CP:<cpName> | DG:<dgName> | Website:<websiteName> | Program:<programName>


) オブジェクト タイプがプログラムの場合、この動作を実行するには管理者レベルのアクセス権限が必要です。


getPrograms

指定されたすべてのプログラムまたはすべてのプログラムとその詳細をリスト表示します。

パラメータ

プログラム タイプ、プログラム名、チャネル ID、プログラム ID のリスト、またはキーワード all のいずれかが必須

結果

指定されたすべてのプログラムとその詳細のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getPrograms&param=all | type=<tvOut | export | wmt | real | ciscoStreamingEngine> | name=<program_name>, <program_name>... | channel=<channelID> | id=<programID>


) この動作を実行するには、管理者レベルのアクセス権限が必要です。


getPgmMcastAddrInUse

現在、プログラムによって使用されているすべてのマルチキャスト アドレスをリスト表示します。

パラメータ

なし

結果

現在、プログラムによって使用されているすべてのマルチキャスト アドレスのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getPgmMcastAddrInUse


) この動作を実行するには、管理者レベルのアクセス権限が必要です。


getMcastAddrInUse

プログラムによって使用されるアドレスやその他のアドレス(たとえば、マルチキャスト コンテンツ配信用に使用されるアドレス)を含めて、現在使用中のすべてのマルチキャスト アドレスをリスト表示します。

パラメータ

なし

結果

現在使用中のすべてのマルチキャスト アドレスのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getMcastAddrInUse


) この動作を実行するには、管理者レベルのアクセス権限が必要です。


getPgmMcastAddrRange

プログラム用に予約されたマルチキャスト アドレス範囲をリスト表示します。

パラメータ

なし

結果

プログラム用に予約されているマルチキャスト アドレスの開始アドレスと終了アドレス。または何も割り当てられていない場合は、空のリスト。この動作が空のリストを返した場合、ACNS ネットワークがマルチキャスト イベントをサポートするように構成されていないことを示します。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ListApiServlet?action=getPgmMcastAddrRange


) この動作を実行するには、管理者レベルのアクセス権限が必要です。