Menu

Lumen help

Real time monitoring (RTM) (Caching)

Description

Returns real-time monitoring (RTM) data for given access group.

Method

GET

Schema location

https://ws.lumen.com/schema/cachingRTM/v1.0

Base URI

https://ws.lumen.com

URI syntax

/rtm/cdn/(version)/(scope)?serviceType=(servicetype)[&geo=(geo)] [&property=true]

cdn Required. Names CDN API as the correct engine.
version Required version.
scope
/(AG)/
or
/(AG)/(SCID)/
or
/(AG)/(SCID)/(NI)/		 Required. Scope for caching is by Access Group ID. AG is Access Group ID.
Scope cannot have an optional middle value. AG is Access Group ID. NI is network identifier name.
property=true Optional. Provides RTM data at the NI level.
serviceType “caching” | “c” | Required service type when using caching (as caching RTM is provided on the access group level).
geo “none” | “region” | "metro" | "clientRegion" Optional. Specify the level of granularity for geographic reporting. None reports at access group level, region at continent levels, and metro at metropolitan area levels.

Note: Queries without this parameter return metro data.
accessGroupChildren Optional. Returns RTM data for an access group and child access groups within its hierarchy.

Note: Implement the Caching RTM calls with three or more minutes between requests so that each request can be properly filled.

Example 1

https://ws.lumen.com/rtm/cdn/v1.0/12345?serviceType=c

<?xml version="1.0" encoding="UTF-8"?>
<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation=“(Undefined variable: Primary.API Schema URI)/cachingRTM/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1270071184562-8650</apiCorrelationId>
<time>2010-02-01 00:00 +0000</time>
<serviceResource>/12345</serviceResource>
<metros>
<metro name="Atlanta, GA" region="North America" latitude="33.44"
longitude="-84.23">
<Mbps>184</Mbps>
<requestsPerSecond>295.83</requestsPerSecond>
<missMbps>0.13</missMbps>
<missPerSecond>55.94</missPerSecond>
<status404PerSec>1.54</status404PerSec>
<status503PerSec>0</status503PerSec>
<status504PerSec>6.59</status504PerSec>
<status5xxPerSec>6.59</status5xxPerSec>
<ptPerSec>1.28</PTPerSec>
<hitRatePercentage>86.25</hitRatePercentage>
<authPercentage>0.00</authPercentage>
<signedPercentage>0.00</signedPercentage>
</metro>
<metro name="Vienna, AT" region="Europe" lat="48.14" long="16.2">
<Mbps>1.57</Mbps>
<requestsPerSecond>2.93</requestsPerSecond>
<missMbps>0</missMbps>
<missPerSecond>2.4</missPerSecond>
<status404PerSec>0</status404PerSec>
<status503PerSec>0</status503PerSec>
<status504PerSec>0</status504PerSec>
<status5xxPerSec>0</status5xxPerSec>
<ptPerSec>0.03</PTPerSec>
<hitRatePercentage>45.43</hitRatePercentage>
<authPercentage>0.00</authPercentage>
<signedPercentage>0.00</signedPercentage>
</metro>
</metros>
</accessGroup>

Example 2

https://ws.lumen.com/rtm/cdn/v1.0/12345?serviceType=c&geo=region

<?xml version="1.0" encoding="UTF-8"?>
<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation=
“(Undefined variable: Primary.API Schema URI)/cachingRTM/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<accessGroup id="12345" name="My Access Group">
<apiCorrelationId>CDNPortal-1292452796752-1022</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<time>2010-12-15 22:37:01 +0000</time>
<mbps>9.360001</mbps>
<requestsPerSecond>4.299999</requestsPerSecond>
<missMbps>0.01</missMbps>
<missPerSecond>1.2199999</missPerSecond>
<status404PerSec>0.0</status404PerSec>
<status503PerSec>0.0</status503PerSec>
<status504PerSec>0.0</status504PerSec>
<status5xxPerSec>0.0</status5xxPerSec>
<ptPerSec>0.16</ptPerSec>
<hitRatePercentage>NaN</hitRatePercentage>
<authPercentage>NaN</authPercentage>
<signedPercentage>NaN</signedPercentage>
<regions>
<region name="North America">
<mbps>6.6800003</mbps>
<requestsPerSecond>3.4099994</requestsPerSecond>
<missMbps>0.01</missMbps>
<missPerSecond>0.73999995</missPerSecond>
<status404PerSec>0.0</status404PerSec>
<status503PerSec>0.0</status503PerSec>
<status504PerSec>0.0</status504PerSec>
<status5xxPerSec>0.0</status5xxPerSec>
<ptPerSec>0.16</ptPerSec>
<hitRatePercentage>91.08448</hitRatePercentage>
<authPercentage>0.0</authPercentage>
<signedPercentage>0.0</signedPercentage>
</region>
<region name="...
</region>
</regions>
</accessGroup>

Example 3: Access group, by property

https://ws.lumen.com/rtm/cdn/v1.0/12345/?serviceType=c&property=true

<accessGroup id="12345" name="My Access Group">
<apiCorrelationId>CDNPortal-1300295389283-1600</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<time>2012-03-15 22:44:01 +0000</time>
<services>
<service id="12345">
<serviceResource>/12345</serviceResource>
<networkIdentifiers>
<ni id=cdn.lumen.com>
<serviceResource>/12345/BBBL1111/cdn.level3.com</serviceResource>
<mbps>17482.7</mbps>
<requestsPerSecond>26238.7</requestsPerSecond>
<missMbps>921.05</missMbps>
<missPerSecond>986.08</missPerSecond>
<status404PerSec>3.49</status404PerSec>
<status503PerSec>0</status503PerSec>
<status504PerSec>0</status504PerSec>
<status5xxPerSec>0</status5xxPerSec>
<ptPerSec>233.2</ptPerSec>
<hitRatePercentage>99.84</hitRatePercentage>
<authPercentage>0.00</authPercentage>
<signedPercentage>0.00</signedPercentage>
</ni>
<ni id="...">
</ni>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Example 4: NI and caching RTM data

https://ws.lumen.com/rtm/cdn/v1.0/12345/BL1111/cdn.level3.com?serviceType=c

<accessGroup id="12345" name="Win Update - MSFT End Cust" xsi:noNamespaceSchemaLocation= "(Undefined variable: Primary.API Schema URI)/cachingRTM/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1331852553017-5039</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<services>
<service id="BL1111">
<serviceResource>/12345/BL1111</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id="cdn.lumen.com">
<serviceResource>/12345/BL1111/cdn.level3.com</serviceResource>
<product>CACHING</product>
<time>2012-03-15 23:02:33 +0000</time>
<metros>
<metro name="Atlanta, GA" region="North America"
latitude="33.44" longitude="-84.23">
<mbps>8864.86</mbps>
<requestsPerSecond>9178.78</requestsPerSecond>
<missMbps>39.59</missMbps>
<missPerSecond>28.38</missPerSecond>
<status404PerSec>0</status404PerSec>
<status503PerSec>0</status503PerSec>
<status504PerSec>0</status504PerSec>
<status5xxPerSec>0</status5xxPerSec>
<ptPerSec>78.35</ptPerSec>
<hitRatePercentage>99.99</hitRatePercentage>
<authPercentage>0.00</authPercentage>
<signedPercentage>0.00</signedPercentage>
</metro>
<metro name="Boston, MA" region="North America"
latitude="42.22" longitude="-71.2">
<mbps>223.69</mbps>
<requestsPerSecond>194.78</requestsPerSecond>
<missMbps>3.17</missMbps>
<missPerSecond>1.52</missPerSecond>
<status404PerSec>0</status404PerSec>
<status503PerSec>0</status503PerSec>
<status504PerSec>0</status504PerSec>
<status5xxPerSec>0</status5xxPerSec>
<ptPerSec>9.08</ptPerSec>
<hitRatePercentage>99.98</hitRatePercentage>
<authPercentage>0.00</authPercentage>
<signedPercentage>0.00</signedPercentage>
</metro>
</metros>
</ni>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Example 5: Child access groups, plus region data

https://ws.lumen.com/rtm/cdn/v1.0/12345?serviceType=c&accessGroupChildren=true&geo=region

Returns caching RTM data for AG 12345 and data in each of the child access groups, as well as region data within the respective access groups.

<accessGroup id="12345" name="My Access Group">
<apiCorrelationId>CDNPortal-1300292824937-0561</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<networkIdentifiers>
<ni>smoothlive.lumen.com</ni>
<ni>iphonelive.lumen.com</ni>
<ni>smooth.lumen.com</ni>
<ni>cdn.lumen.com</ni>
<ni>www.lumentest.com</ni>
</networkIdentifiers>
<time>2011-03-16 16:25:32 +0000</time>
<mbps>4.25</mbps>
<requestsPerSecond>4.93</requestsPerSecond>
<missMbps>0.0</missMbps>
<missPerSecond>0.55999994</missPerSecond>
<status404PerSec>0.0</status404PerSec>
<status503PerSec>0.0</status503PerSec>
<status504PerSec>0.0</status504PerSec>
<status5xxPerSec>0.0</status5xxPerSec>
<ptPerSec>0.46</ptPerSec>
<hitRatePercentage>94.86458</hitRatePercentage>
<authPercentage>0.0</authPercentage>
<signedPercentage>0.0</signedPercentage>
<regions>
<region name="North America">
<mbps>3.13</mbps>
<requestsPerSecond>4.19</requestsPerSecond>
<missMbps>0.0</missMbps>
<missPerSecond>0.45999998</missPerSecond>
<status404PerSec>0.0</status404PerSec>
<status503PerSec>0.0</status503PerSec>
<status504PerSec>0.0</status504PerSec>
<status5xxPerSec>0.0</status5xxPerSec>
<ptPerSec>0.46</ptPerSec>
<hitRatePercentage>94.892235</hitRatePercentage>
<authPercentage>0.0</authPercentage>
<signedPercentage>0.0</signedPercentage>
</region>
<region name="Europe">
...
</regions>
</accessGroup>

Possible status and error messages returned to client

Additional return codes and error messages