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

目次

複製状況 API

複製状況 API の動作

getChannels

getCEsOfChannel

getChannelsOfCE

getReplicatedContent

getNonReplicatedContent

getContent

getStatusOfContentItems

getStatusOfContentItemInChannel

XML 形式の出力

複製状況 API

この章では、複製状況 API およびこの API によって実行される servlet 動作について説明します。複製状況 API は、チャネル、Content Engine、またはコンテンツのリストを返し、指定されたチャネルのコンテンツの複製が完了したかどうかをチャネルごとに示します。

複製状況 API の動作

複製状況 API は、ReplicationStatusApiServlet と記述します。

構文

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

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

getChannels

getCEsOfChannel

getChannelsOfCE

getReplicatedContent

getNonReplicatedContent

getContent

getStatusOfContentItems

getStatusOfContentItemInChannel

getChannels

指定されたチャネルのコンテンツの複製状況を取得します。

パラメータ

チャネル ID のリストまたはキーワード all のいずれかが必須です。

結果

チャネルのリスト、およびチャネルごとに、指定のチャネルの複製が完全か不完全かを示すフラグ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getChannels&channel=[all | <channel_ID>,<channel_ID>,...]

getCEsOfChannel

指定されたチャネルに割り当てられているすべての Content Engine のコンテンツの複製状況を取得します。

パラメータ

チャネル ID(必須)

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合、新たに更新された状況を取得するためのバックグラウンド要求が、このチャネルに割り当てられたすべての Content Engine に送信されます。新たに利用可能となった情報を表示するには、再取得を数分間停止したあとで、再度 API を呼び出す必要があります。

結果

指定のチャネルに割り当てられた Content Engine のリスト、および Content Engine ごとに、指定の Content Engine の複製が完全か不完全かを示すフラグ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getCEsOfChannel&channel=<channel_ID>[&refetch=<true | false>]

getChannelsOfCE

指定の Content Engine に割り当てられたすべてのチャネルのコンテンツの複製状況を取得します。

パラメータ

Content Engine ID(必須)

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合、新たに更新された状況を取得するためのバックグラウンド要求が、このチャネルに割り当てられたすべての Content Engine に送信されます。新たに利用可能となった情報を表示するには、再取得を数分間停止したあとで、再度 API を呼び出す必要があります。

結果

指定の Content Engine に割り当てられた Content Engine のリスト、および指定の Content Engine の複製が完全か不完全かをContent Engine ごとに示すフラグ

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getChannelsOfCE&ce=<CE_ID>[&refetch=<true | false>]

getReplicatedContent

検索基準とは関係なく、指定のチャネル上の指定の Content Engine の複製アイテムをすべてリスト表示します。

パラメータ

Content Engine ID(必須)

チャネル ID(必須)

検索基準(任意)

コンテンツ名またはパターンが複数ある場合は、カンマで区切る必要があります。パターンには、* または ?(ワイルドカード)を含めることができます。

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合は、バックグラウンドでコンテンツを取得する要求が発行されます。更新された情報は Content Distribution Manager にキャッシングされ、次回のコールで取得することができます。

結果

検索基準を指定した場合、検索基準に一致する指定のチャネルの指定の Content Engine 上の、すべての複製済みコンテンツ アイテムのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getReplicatedContent&ce=<CE_ID>&channel=<channel_ID>[&criteria=<criteria>][&refetch=<true | false>]

getNonReplicatedContent

検索基準とは関係なく、指定のチャネル上の指定の Content Engine の非複製アイテムをすべてリスト表示します。

パラメータ

Content Engine ID(必須)

チャネル ID(必須)

検索基準(任意)

コンテンツ名またはパターンが複数ある場合は、カンマで区切る必要があります。パターンには、* または ?(ワイルドカード)を含めることができます。

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合は、バックグラウンドでコンテンツを取得する要求が発行されます。更新された情報は Content Distribution Manager にキャッシングされ、次回のコールで取得することができます。

結果

検索基準を指定した場合、検索基準に一致する指定のチャネルの指定の Content Engine 上の、すべての非複製コンテンツ アイテムのリストこのリストには、複製プロセスの過程でまだ複製されていないコンテンツ アイテム、または複製に失敗したアイテムもが含まれます。

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getNonReplicatedContent&ce=<CE_ID>&channel=<channel_ID>[&criteria=<criteria>][&refetch=<true | false>]

getContent

検索基準とは関係なく、指定のチャネル上の指定の Content Engine のコンテンツ アイテムをすべてリスト表示します。

パラメータ

Content Engine ID(必須)

チャネル ID(必須)

検索基準(任意)

コンテンツ名またはパターンが 1 つまたは複数ある場合は、カンマで区切る必要があります。パターンには、* または ?(ワイルドカード)を含めることができます。

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合は、バックグラウンドでコンテンツを取得する要求が発行されます。更新された情報は Content Distribution Manager にキャッシングされ、次回のコールで取得することができます。

結果

検索基準を指定した場合、検索基準に一致する指定のチャネルの指定の Content Engine 上の、すべてのコンテンツ アイテムのリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getContent&ce=<CE_ID>&channel=<channel_ID>[&criteria=<criteria>][&refetch=<true | false>]

getStatusOfContentItems

検索基準とは関係なく、チャネルに割り当てられているすべての Content Engine 内のコンテンツ アイテムをリスト表示します。

パラメータ

チャネル ID(必須)

検索基準(任意)

コンテンツ名またはパターンが 1 つまたは複数ある場合は、カンマで区切る必要があります。パターンには、* または ?(ワイルドカード)を含めることができます。

Refetch(再取得)(任意) -- デフォルトは false です。

再取得を true に設定した場合は、バックグラウンドでコンテンツを取得する要求が発行されます。更新された情報は Content Distribution Manager にキャッシングされ、次回のコールで取得することができます。


) 再取得を true に設定すると、新しい情報を取得するために、チャネルに割り当てられた Content Engine に要求が送られます。これはプロセッサへの負荷が大きい操作です。


結果

チャネル内のすべてのコンテンツ アイテムと Content Engine 全体におけるそれらの状況のリスト。または、検索基準が指定されている場合は、指定の基準に一致するコンテンツ アイテムと Content Engine 全体におけるそれらの状況のリスト

構文

https://<cdmIpAddress>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getStatusOfContentItems&channel=<Channel_ID>[&criteria=<criteria>][&refetch=<true | false>]

getStatusOfContentItemInChannel

チャネルに割り当てられているすべての Content Engine の指定のコンテンツ アイテムの状況をリスト表示します。

パラメータ

チャネル ID(必須)

コンテンツ アイテムの完全な URL(必須)

結果

チャネルに割り当てられているすべての Content Engine の指定のコンテンツ アイテムの状況


) この動作は getStatusOfContentItems のあとで呼び出す必要があります。そうしないと、予想外の出力結果になる場合があります。URL は、getStatusOfContentItems 動作の出力にリスト表示されている URL でなければなりません。


構文

https://<cdmIpAddr>:8443/servlet/com.cisco.unicorn.ui.RepStatusApiServlet?action=getStatusOfContentItemInChannel&channel=<Channel_ID>&criteria=<complete URL of the channel content item>

XML 形式の出力

次の例は、XML 形式で出力された Document Type Definition(DTD)です。

<?xml version="1.0"?>
<!DOCTYPE replicationStatus[
<!ELEMENT replicationStatus (message, CeStatus*, ChannelStatus*)>
<!ATTLIST replicationStatus
action CDATA #REQUIRED
count CDATA #REQUIRED
>
<!ELEMENT message EMPTY>
<!ATTLIST message
status (success | failure) "success"
message CDATA #REQUIRED
>
<!ELEMENT CeStatus EMPTY>
<!ATTLIST CeStatus
ceId CDATA #REQUIRED
ceName CDATA #IMPLIED
channelId CDATA #REQUIRED
channelName CDATA #IMPLIED
state CDATA #IMPLIED
filesDone CDATA #IMPLIED
filesToDo CDATA #IMPLIED
filesFailed CDATA #IMPLIED
filesUpdateFailed CDATA #IMPLIED
totalFiles CDATA #IMPLIED
updateTime CDATA #IMPLIED
>
<!ELEMENT ChannelStatus EMPTY>
<!ATTLIST ChannelStatus
id CDATA #REQUIRED
totalNumCes CDATA #REQUIRED
numCesComplete CDATA #REQUIRED
numCesInProcess CDATA #REQUIRED
numCesFailed CDATA #REQUIRED
numCesUnknownState CDATA #REQUIRED
rootCeState CDATA #REQUIRED
manifestError CDATA #IMPLIED
usedDiskQuota CDATA #IMPLIED
validAsOf CDATA #IMPLIED
>