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

目次

プロビジョニング API

チャネル プロビジョニング API の動作

createChannel

addManifest

assignCEs

assignDGs

fetchNow

modifyChannel

modifyManifest

unassignCEs

unassignDGs

deleteChannels

createContentProvider

modifyContentProvider

deleteContentProvider

createWebSite

modifyWebSite

deleteWebSites

ロケーション プロビジョニング API の動作

createLocation

modifyLocation

deleteLocation

Content Engine プロビジョニング API の動作

activateCe

changeCeLocation

deleteCe

contentRoutingQuery

プログラム API の動作

createProgram

validateProgramFile

assignChannel

assignCEs

assignDGs

fetchNow

modifyProgramFile

unAssignChannel

unAssignCEs

unAssignDGs

deletePrograms

startSession

pauseSession

stopSession

プロビジョニング API

この章では、チャネル プロビジョニング API、ロケーション プロビジョニング API、Content Engine プロビジョニング API、プログラム API、およびこれらの API が実行する servlet 動作について説明します。この章の構成は、次のとおりです。

「チャネル プロビジョニング API の動作」

「ロケーション プロビジョニング API の動作」

「Content Engine プロビジョニング API の動作」

「プログラム API の動作」

チャネル プロビジョニング API の動作

チャネル プロビジョニング API は、ChannelApiServlet と記述します。

構文

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

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

createChannel

addManifest

assignCEs

assignDGs

fetchNow

modifyChannel

modifyManifest

unassignCEs

unassignDGs

deleteChannels

createContentProvider

modifyContentProvider

deleteContentProvider

createWebSite

modifyWebSite

deleteWebSites

createChannel

チャネルを作成します。

パラメータ

チャネル名(必須)

指定のチャネルに関連付けられた Web サイト ID(必須)

weak 認証(任意) -- デフォルトは false です。

暗号化のスキップ(任意) -- デフォルトは false です。

チャネル優先順位(任意) -- デフォルトは normal です。

設定値は次のとおりです。

High(高い)

Normal(普通)

Low(低い)

マルチキャストの有効化(任意) -- デフォルトは false です。

設定値は次のとおりです。

true -- ユニキャストのみ

false -- ユニキャストおよびマルチキャスト

unicast_only -- ユニキャストのみ

multicast_only -- マルチキャストのみ

unicast_multicast -- ユニキャストおよびマルチキャスト

チャネルに関する記述(任意) -- デフォルトは null です。

ライブ(任意) -- デフォルトは false です。

結果

新規に作成されたチャネル ID


) ACNS 5.3 ソフトウェアには、チャネルを作成して、マルチキャスト クラウドに割り当てる API は用意されていません。Content Distribution Manager GUI を使用して、チャネルをマルチキャスト クラウドに割り当ててください。


構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=createChannel&channel=<channel_name>&website=<website_ID>[&weakCert=<true | false>][&skipEncrypt= <true | false>][&priority=<high | normal | low>][&mcastEnable=<true | false | unicast_only | multicast_only | unicast_multicast>][&desc=<description>][&live=<true | false>]

addManifest

マニフェスト ファイルを指定のチャネルに追加します。

パラメータ

チャネル ID(必須)

マニフェスト URL(必須)

Quota(割り当て量)(必須)

TTL(必須) -- 分単位

ユーザ ID(任意)

ユーザ パスワード(任意)

ユーザ ドメイン名(任意)

非基本認証(任意) -- デフォルトは false です。

非プロキシ(任意) -- デフォルトは false です。

プロキシ IP アドレスまたはホスト名(任意)

プロキシ ポート(任意)

プロキシ ユーザ名(任意)

プロキシ パスワード(任意)

プロキシ NTLM ユーザ ドメイン名(任意)

プロキシ非基本認証(任意) -- デフォルトは false です。

結果

更新されたチャネル レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=addManifest&channel=<channel_ID>&manifest=<manifest_URL>&quota=<quota>&ttl=<ttl>[&user=<user_name>][&password=<password>][&userDomainName=<user_domain_name>][&notBasicAuth=<true|false>][&noProxy=<true|false>][&proxyIpHostname=<proxy_ip_hostname>][&proxyPort=<proxy_port>][&proxyUser=<proxy_user>][&proxyPassword=<proxy_password>][&proxyNtlmUserDomainName=<proxy_ntlm_user_domain_name>][&proxyNotBasicAuth=<true|false>]

assignCEs

Content Engine を指定のチャネルに割り当てます。

assignChannel 動作がすでに使用されている場合は、この動作を使用する必要はありません。チャネルがすでにプログラムに割り当てられている場合、assignCEs 動作は正常に実行されますが、警告メッセージが返されます。

パラメータ

チャネル ID(必須)

ルート Content Engine ID(ルート Content Engine が割り当てられていない場合は必須。それ以外での場合は任意)

Content Engine のリストまたはキーワード all (下記のルールを参照)

クラスタのリストまたはキーワード all (下記のルールを参照)

ルール

Content Engine パラメータ リストを all に設定している場合、クラスタ リストを指定することはできません。

クラスタ リストを all に設定している場合、Content Engine リストを指定することはできません。

Content Engine リストとクラスタ リストを、同時に all に設定することはできません。

ルールに違反すると、エラーメッセージが返されます。

結果

なし


) Content Engine とクラスタは、1 対 1 の関係で対応しています。クラスタは Content Engine の周囲に配置されたラッパーとして見なされます。


Content Engine を割り当てる場合、次のオプションから 1 つを指定します。

Content Engine のリスト

すべての Content Engine

クラスタのリスト

すべてのクラスタ

Content Engine とクラスタのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=assignCEs&channel=<channel_ID>[&rootCe=<root_CE_ID>][&ce=all | <CE_ID>,<CE_ID>, �[&cluster=all | <Cluster_ID>,<Cluster_ID>, ...]

assignDGs

指定のチャネルにデバイス グループ(DG)を割り当てます。

assignChannel 動作がすでに使用されている場合は、この動作を使用する必要はありません。チャネルがすでにプログラムに割り当てられている場合、assignDGs 動作は正常に実行されますが、警告メッセージが返されます。

パラメータ

チャネル ID(必須)

ルート Content Engine ID(ルート Content Engine が割り当てられていない場合は必須。それ以外の場合は任意)

デバイス グループのリスト(必須)


) デバイス グループの中には Content Engine が含まれていないものがあるので、キーワード all は使用できません。


結果

なし

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=assignDGs&channel=<channel_ID>[&rootCe=<root_CE_ID>]&dg=<DG_ID>,<DG_ID>, ...

fetchNow

マニフェスト ファイルを即時に取得します。

通常、マニフェストの ttl (Time-to-Live; 存続可能時間)値は、適正な値(30 分など)に設定されています。この servlet は、通常の ttl インターバルが指定のチャネルで期限切れになる前に、マニフェスト ファイルのフレッシュネスを強制的にチェックします。変更されたマニフェスト ファイルは分析され、コンテンツが処理されます。マニフェスト ファイルに対する変更を即時に処理する場合は、fetchNow 動作を使用します。

パラメータ

チャネル ID(必須)

結果

なし

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=fetchNow&channel=<channel_ID>

modifyChannel

チャネル設定値を変更します。

パラメータ

チャネル ID(必須)

チャネル名(任意)

weak 認証(任意)

暗号化のスキップ(任意)

チャネル優先順位(任意)

設定値は次のとおりです。

High(高い)

Normal(普通)

Low(低い)

マルチキャストの有効化(任意)

設定値は次のとおりです。

true -- ユニキャストのみ

false -- ユニキャストおよびマルチキャスト

unicast_only -- ユニキャストのみ

multicast_only -- マルチキャストのみ

unicast_multicast -- ユニキャストおよびマルチキャスト

説明(任意)

ライブ(任意)


) パラメータを指定しない場合、元のチャネル設定値は変更されません。


結果

更新されたチャネル レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=modifyChannel&channel=<channel_ID>[&channelName=<channel_name>][&weakCert=<true | false>][&skipEncrypt=<true | false>][&priority=<high | normal | low>][&mcastEnable=<true | false> | unicast_only | multicast_only | unicast_multicast][&desc=<description>][&live=<true | false>]

modifyManifest

マニフェスト ファイルの設定値を変更します。

パラメータ

チャネル ID(必須)

マニフェスト URL(任意)

Quota(割り当て量)(任意)

TTL(任意)

ユーザ ID(任意)

ユーザ パスワード(任意)

NTLM ユーザ ドメイン名(任意)

非基本認証(任意) -- デフォルトは false です。

非プロキシ(任意) -- デフォルトは false です。

プロキシ IP アドレスまたはホスト名(任意)

プロキシ ポート(任意)

プロキシ ユーザ名(任意)

プロキシ パスワード(任意)

プロキシ NTLM ユーザ ドメイン名(任意)

プロキシ非基本認証(任意) -- デフォルトは false です。


) パラメータを指定しない場合、元のマニフェスト ファイルの設定値は変更されません。パラメータ値を削除する必要がある場合は、"空ストリング" メカニズムを使用して既存の設定を削除します。たとえば、もともとチャネルに設定してあったマニフェストを削除するには、modifyManifest 動作を使用するときにマニフェスト パラメータを空のストリング(manifest="")に設定します。


マニフェスト URL を null に設定すると、他のすべてのパラメータ設定値が削除されます。

結果

更新されたチャネル レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=modifyManifest&channel=<channel_ID>[&manifest=<manifest_URL>][&quota=<quota>][&ttl=<ttl>][&user=<user_name>][&password=<password>][&userDomainName=<user_domain_name>][&notBasicAuth=<true | false>][&noProxy=<true | false>][&proxyIpHostname=<proxy_ip_hostname>][&proxyPort=<proxy_port>][&proxyUser=<proxy_user>][&proxyPassword=<proxy_password>][&proxyNtlmUserDomainName=<proxy_ntlm_user_domain_name>][&proxyNotBasicAuth=<true | false>]

unassignCEs

指定のチャネルから Content Engine を削除します。

unAssignChannel 動作がすでに使用されている場合は、この動作を使用する必要はありません。チャネルがすでにプログラムに割り当てられている場合、unassignCEs 動作は正常に実行されますが、警告メッセージが返されます。

パラメータ

チャネル ID(必須)

Content Engine のリストまたはキーワード all のいずれかが必須(下記のルールを参照)

クラスタのリストまたはキーワード all のいずれかが必須(下記のルールを参照)

ルール

Content Engine リストを all に設定している場合、クラスタ リストは指定できません。

クラスタ リストを all に設定している場合、Content Engine リストは指定できません。

Content Engine リストとクラスタ リストを、同時に all に設定することはできません。

ルールに違反すると、エラーメッセージが返されます。

結果

なし


) Content Engine とクラスタは、1 対 1 の関係で対応しています。クラスタは Content Engine の周囲に配置されたラッパーとして見なされます。


チャネルから Content Engine を削除する場合、次のオプションから 1 つを指定します。

Content Engine のリスト

すべての Content Engine

クラスタのリスト

すべてのクラスタ

Content Engine とクラスタのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=unassignCEs&channel=<channel_ID>[&ce=all | <CE_ID>, <CE_ID> ...][&cluster=all | <Cluster_ID>, <Cluster_ID>, ...]

unassignDGs

デバイス グループを指定のチャネルから削除します。

unAssignChannel 動作がすでに使用されている場合は、この動作を使用する必要はありません。チャネルがすでにプログラムから削除されている場合、unassignDGs 動作は正常に実行されますが、警告メッセージが返されます。

パラメータ

チャネル ID(必須)

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

結果

なし

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=unassignDGs&channel=<channel_ID>&dg=all | <DG_ID>, <DG_ID>, ...

deleteChannels

チャネルを削除します。

パラメータ

チャネルのリストまたはキーワード all のいずれか(必須)

結果

なし

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=deleteChannels&channel=all | <channel_ID>, <channel_ID> ...

createContentProvider

コンテンツ プロバイダーを作成します。

パラメータ

コンテンツ プロバイダー名(必須)

説明(任意)

主な連絡先名(任意)

主な連絡先の電話番号(任意)

主な連絡先の E メール(任意)

結果

コンテンツ プロバイダーが新規に作成され、そのコンテンツ プロバイダーの連絡先情報が保存されたことの確認

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=createContentProvider&name=<content_provider_name>[&description=<description>][&contactName=<primary_contact_name>][&contactPhone=<primary_contact_phone>][&contactEmail=<primary_contact_email>]

modifyContentProvider

コンテンツ プロバイダーの設定値を変更します。

パラメータ

コンテンツ プロバイダー ID(必須)

コンテンツ プロバイダー名(任意)

説明(任意)

主な連絡先名(任意)

主な連絡先の電話番号(任意)

主な連絡先の E メール(任意)

結果

コンテンツ プロバイダーの設定値が変更されたこと、およびコンテンツ プロバイダーの更新されたレコードの確認

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=modifyContentProvider&cp=<content_provider_ID>[&name=<name>][&description=<description>][&contactName=<primary_contact_name>][&contactPhone=<primary_contact_phone>][&contactEmail=<primary_contact_email>]

deleteContentProvider

コンテンツ プロバイダーを削除します。

パラメータ

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

結果

コンテンツ プロバイダーが削除されたことの確認

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=deleteContentProviders&cp=all | <cp_ID>, <cp_ID>, ...

createWebSite

Web サイトを作成します。

パラメータ

Web サイト名(必須)

コンテンツ プロバイダー ID(必須)

オリジン サーバ(必須)

完全修飾ドメイン名(FQDN)(任意)


) これは、要求を Content Engine にルーティングする Content Router によって使用される FQDN です。たとえば、http://www.cnn.com(オリジン サーバの FQDN)に対する要求が処理されている間、Content Router は FQDN http://cdn.cnn.com を使用して、その要求を Content Engine にルーティングできます。


WMT 認証(任意) -- デフォルトは none です。

Basic

NTLM

説明(任意)

結果

Web サイトが作成されたこと、および新規に作成された Web サイト オブジェクトの確認

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=createWebSite&name=<website_name>&cp=<content_provider_ID>&origin=<origin server>[&fqdn=<fqdn>][&wmtAuth=<basic | ntlm>][&description=<description>]

modifyWebSite

Web サイトの設定値を変更します。

パラメータ

Web サイト ID(必須)

Web サイト名(任意)

コンテンツ プロバイダー ID(必須)

オリジン サーバ(任意)

FQDN(任意)

WMT 認証(任意)

なし

Basic

NTLM

説明(任意)

結果

Web サイトの属性が変更されたことの確認、および変更された Web サイト オブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=modifyWebSite&website=<WebSite_ID>[&name=<website_name>][&origin=<origin server>][&fqdn=<fqdn>][&wmtAuth=<none | basic | ntlm>][&description=<description>]

deleteWebSites

Web サイトを削除します。

パラメータ

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

結果

Web サイトが削除されたことの確認

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ChannelApiServlet?action=deleteWebSites&website=all | <website_ID>, <website_ID>, ...

ロケーション プロビジョニング API の動作

ロケーション プロビジョニング API は、LocationApiServletと記述します。

構文

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

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

createLocation

modifyLocation

deleteLocation

createLocation

指定のロケーションを作成します。

パラメータ

ロケーション名(必須)

親ロケーション ID(任意)

説明(任意)

結果

新規に作成されたロケーション オブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.LocationApiServlet?action=createLocation&location=<location_name>[&parent=<parent_ID>][&desc=<description>]

modifyLocation

指定のロケーションを変更します。

パラメータ

ロケーション ID(必須)

ロケーション名(任意)

親ロケーション ID(任意)

説明(任意)

結果

変更されたロケーション オブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.LocationApiServlet?action=modifyLocation&location=<location_ID>[&name=<location_name>][&parent=<parent_ID>][&desc=<description>]

deleteLocation

指定のロケーションを削除します。

パラメータ

ロケーション ID(必須)

結果

指定のロケーションが削除されたことを示すメッセージ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.LocationApiServlet?action=deleteLocation&location=<location_ID>

Content Engine プロビジョニング API の動作

Content Engine プロビジョニング API は CeApiServlet と記述します。

構文

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

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

activateCe

changeCeLocation

deleteCe

contentRoutingQuery

activateCe

指定の Content Engine を有効にします。

パラメータ

Content Engine ID(必須)

ロケーション ID(必須)

結果

変更された Content Engine オブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.CeApiServlet?action=activateCe&ce=<ce_ID>&location=<location_ID>

changeCeLocation

指定の Content Engine のロケーションを変更します。

パラメータ

Content Engine ID(必須)

ロケーション ID(必須)

結果

変更された Content Engine オブジェクト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.CeApiServlet?action=changeCeLocation&ce=<ce_ID>&location=<location_ID>

deleteCe

指定の Content Engine を削除します。

パラメータ

Content Engine ID(必須)

結果

指定の Content Engine が削除されたことを示すメッセージ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.CeApiServlet?action=deleteCe&ce=<ce_ID>

contentRoutingQuery

Content Router が選択する Content Engine を決定します。

パラメータ

クライアント IP アドレス -- IPv4 アドレスのみがサポートされます。

Fully Qualified Domain Name(FQDN; 完全修飾ドメイン名)の Web サイト -- この FQDN は、Content Distribution Manager GUI の Request Routed FQDN フィールドで設定された FQDN と同じである必要があります。

結果

Content Router が選択した Content Engine の名前

構文

http://<crIpAddress>:8888/content-routing-query?clientIp=<clientIpAddress>&website=<website FQDN>


) 着信 API コール形式が正しくない場合は、コール要求は廃棄されます。ユーザ側では、タイムアウトまたは接続エラーが発生したり、エラーを記述する HTML ファイルが作成される場合があります。


Content Engine が検出された場合、Content Router は次のような応答を表示します。

<?xml version="1.0" encoding="ISO-8859-1" ?>
<ContentRoutingApiResponse>
<Status> 0 </Status>
<Error> None </Error>
<CE> <name of ContentEngine> </CE>
</ContentRoutingApiResponse>
 

CE が検出されない場合や API コール処理にエラーがある場合は、ステータス要素は非ゼロに設定され、CE 要素は NotFound に設定されます。

次に、ステータス コードおよび対応するエラーを示します。

 

ステータス
エラー

1

不明なドメイン

2

カバレッジゾーン内に存在しません。

3

一時的に使用できません。

4

API 形式が正しくありません。

プログラム API の動作

プログラム API は ProgramApiServlet と記述します。

構文

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


) プログラム API の動作を実行するには、管理者レベルのアクセス権が必要です。


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

createProgram

validateProgramFile

assignChannel

assignCEs

assignDGs

fetchNow

modifyProgramFile

unAssignChannel

unAssignCEs

unAssignDGs

deletePrograms

startSession

pauseSession

stopSession

createProgram

HTTP を使用してプログラム ファイルをフェッチして検証し、入力に基づいてプログラムを作成します。プログラムで必要とされる場合、この動作はマルチキャスト アドレスも予約します。プログラム用に予約されたマルチキャスト アドレスは、プログラムが削除されるまで解放されません。

パラメータ

プログラム ファイル URL(必須)

更新間隔(必須) -- 更新をチェックするためにプログラム ファイルにアクセスする間隔(分単位)

ユーザ ID(任意)

ユーザ パスワード(任意)

結果

新規に作成されたプログラム レコード(プログラム ID を含む)。プログラム ファイルの検証が失敗した場合、エラー メッセージが戻されます。

付録 A「ACNS ソフトウェアのプログラム ファイル」 に、返される情報の DTD を示します。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=createProgram&file=<program_file_URL>&updateInterval=<update_interval_minutes>[&user=<user_name>][&password=<password>]

validateProgramFile

HTTP を使用してプログラム ファイルを取得し、それを検証します。

パラメータ

プログラム ファイル URL(必須)

結果

エラーがない場合は、なし。エラーがある場合は、エラーのリストが返されます。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=validateProgramFile&file=<program_file_URL>

assignChannel

チャネルをプログラムに割り当てます。チャネルをプログラムに割り当てると、そのチャネルに関わるすべての Content Engine がプログラムに関連付けられます。Content Engine チャネルの割り当てを変更すると、プログラムも更新されます。

この動作は、 assignCEs 動作と assignDGs 動作がすでに使用されている場合には使用しないでください。Content Engine またはデバイス グループがすでにプログラムに割り当てられている場合は、assignChannel 動作は失敗し、次のエラー メッセージが返されます。

<?xml version="1.0" ?>
- <programApi action="assignChannel">
<message status="fail" message="Constraint Error: Can not associate a channel with the playlist. Content engines are already assigned to the playlist." />
<error code="3" message="Constraint Error: Can not associate a channel with the playlist. Content engines are already assigned to the playlist." />
</programApi>
 

パラメータ

プログラム ID(必須)

チャネル ID(必須)

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=assignChannel&program=<program_ID>&channel=<channel_ID>

assignCEs

Content Engine をプログラムに割り当てます。

この動作は、 assignChannel 動作がすでに使用されている場合には使用しないでください。チャネルがすでにプログラムに割り当てられている場合、assignCEs 動作は失敗し、次のエラー メッセージが返されます。

<?xml version="1.0" ?>
- <programApi action="assignCEs">
<message status="fail" message="Constraint Error: Can not assign content engines to the playlist. The playlist is already associated with a channel." />
<error code="3" message="Constraint Error: Can not assign content engines to the playlist. The playlist is already associated with a channel." />
</programApi>
 

) ライブ プログラムはライブ チャネルに割り当てる必要があるので、プログラムがライブ イベントを表している場合、この動作は失敗します。


パラメータ

プログラム ID(必須)

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

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=assignCEs&program=<program_ID>&ce=all | <CE_ID>, <CE_ID>, ...

assignDGs

デバイス グループをプログラムに割り当てます。

この動作は、 assignChannel 動作がすでに使用されている場合には使用しないでください。チャネルがすでにプログラムに割り当てられている場合、assignDGs 動作は失敗し、次の警告メッセージが返されます。

<?xml version="1.0" ?>
- <programApi action="assignDGs">
<message status="fail" message="Constraint Error: Can not assign device engines to the playlist. The playlist is already associated with a channel." />
<error code="3" message="Constraint Error: Can not assign device engines to the playlist. The playlist is already associated with a channel." />
</programApi>
 

) ライブ プログラムはライブ チャネルに割り当てる必要があるので、プログラムがライブ イベントを表している場合、この動作は失敗します。


パラメータ

プログラム ID(必須)

デバイス グループのリスト(必須)

一部のデバイス グループには Content Router が含まれている場合があるので、キーワード all は使用できません。

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=assignDGs&program=<program_ID>&dg=all | <DG_ID>, <DG_ID>, ...

fetchNow

HTTP を使用して即時にプログラム ファイルを取得し、プログラムを更新します。

パラメータ

プログラム ID(必須)

結果

エラーがない場合は、なし。プログラム ファイルの検証に失敗した場合は、エラー メッセージが表示されます。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=fetchNow&program=<program_ID>

modifyProgramFile

プログラム ファイルの設定値を変更します。

パラメータ

プログラム ID(必須)

プログラム ファイル URL(任意)

更新間隔(任意)

ユーザ ID(任意)

ユーザ パスワード(任意)

パラメータ値を指定しない場合、元のプログラム ファイルの設定値は変更されません。パラメータ値を削除する必要がある場合は、"空ストリング" メカニズムを使用して既存の設定を削除します。たとえば、プログラム ファイルからユーザ ID を削除するには、modifyProgramFile 動作を使用する際に、ユーザ ID パラメータを空ストリング(user="")に設定します。


) プログラム ファイル URL を空ストリングに設定することはできません。プログラム ファイル URL を null に設定すると、他の設定値がすべて削除されます。


結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=modifyProgramFile&program=<program_ID>[&file=<program_file_URL>][&updateInterval=<update_interval>][&user=<user_name>][&password=<password>]

unAssignChannel

指定のプログラムからチャネルを削除します。

この動作は、 unAssignCEs 動作と unAssignDGs 動作がすでに使用されている場合には使用しないでください。Content Engine またはデバイス グループがすでにプログラムから割り当てを解除されている場合、unassignChannel 動作は正常に実行されますが、チャネルがプログラムに割り当てられていないことを示す警告が表示されます。

パラメータ

プログラム ID(必須)

チャネル ID(必須)

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=unassignChannel&program=<program_ID>&channel=<channel_ID>

unAssignCEs

指定のプログラムから Content Engine を削除します。

unAssignChannel 動作がすでに使用されている場合は、この動作を使用する必要はありません。チャネルがすでにプログラムから割り当てを解除されている場合、unassignCEs 動作は正常に実行されますが、Content Engines がプログラムに割り当てられていないことを示す警告が表示されます。

パラメータ

プログラム ID(必須)

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

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=unassignCEs&program=<program_ID>&ce=all | <CE_ID>, <CE_ID>, ...

unAssignDGs

指定のプログラムからデバイス グループを削除します。

unAssignChannel 動作がすでに使用されている場合は、この API 動作を使用する必要はありません。チャネルがすでにプログラムから割り当てを解除されている場合、unassignDGs 動作は正常に実行されますが、デバイス グループがプログラムに割り当てられていないことを示す警告が表示されます。

パラメータ

プログラム ID(必須)

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

結果

更新されたプログラム レコード

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=unassignDGs&program=<program_ID>&dg=all | <DG_ID>, <DG_ID>, ...

deletePrograms

プログラムを削除します。

パラメータ

サービス タイプ(TV-out、エクスポート、WMT、RealMedia、Cisco Streaming Engine など)またはプログラム ID 別のプログラムのリスト、またはキーワード all のいずれかが必須

結果

なし

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.ProgramApiServlet?action=deletePrograms&program=all | id=<program_ID>, <program_ID>,...| type=<tvOut | export | wmt | real | ciscoStreamingEngine>

startSession

クライアントが Play を選択するか、またはコンテンツがストリーミングを開始する際に、HTTP GET 要求を生成します。

パラメータ

サブスクライバまたはクライアントの IP アドレス

コンテンツ ストリームのサブスクライバまたはクライアントの宛先ポート

ストリームを配信する Content Engine の IP アドレス

Content Engine のポート

認証時に Camiant CDN Application Manager Authorization モジュールから返された要求 ID

結果

200 Ok -- 要求は成功しました。

400 Bad request -- 要求パラメータが不完全であるか、または無効でした。QoS 要求は失敗しました。

500 Internal server error -- 内部エラーが発生しました。QoS 要求は失敗しました。

構文

/cdnam/startSession.do?subip=x.x.x.x&subport=n&ceip=y.y.y.y&ceport=m&rid=r

pauseSession

クライアントが Pause を選択すると、HTTP GET 要求を生成します。

パラメータ

認証時に Camiant CDN Application Manager Authorization モジュールから返された要求 ID

結果

200 Ok -- 要求は成功しました。

400 Bad request -- 要求パラメータが不明です。QoS 動作は発生しませんでした。

500 Internal server error -- 内部エラーが発生しました。QoS 要求は失敗しました。

構文

/cdnam/pauseSession.do?rid=r

stopSession

クライアントが Stop を選択するか、またはコンテンツがストリーミングを停止すると、HTTP GET 要求を生成します。

パラメータ

認証時に Camiant CDN Application Manager Authorization モジュールから返された要求 ID

結果

200 Ok -- 要求は成功しました。

400 Bad request -- 要求パラメータが不明です。QoS 動作は発生しませんでした。

500 Internal server error -- 内部エラーが発生しました。QoS 要求は失敗しました。

構文

/cdnam/stopSession.do?rid=r