Menu

Lumen help

Services hierarchy (partially deprecated)

Description

Returns service details for supplied identifier(s) - service hierarchy.

Note: This service functions normally, but will not be enhanced or updated.

Typical use

To determine the SCID and NI portions of the scope that are used to build any of the API calls.

Method

GET

Schema location

https://ws.lumen.com/schema/services/cdn/v1.0

Base URI

https://ws.lumen.com

URI syntax

/services/cdn/(version)/(scope)

cdn Required. Names CDN API as the correct engine.
version Required version.
scope
/(AG)/
or
/(AG)/(SCID)/
or
/(AG)/(SCID)/(NI)/		 Scope must retain sequence that reflects hierarchy. Scope cannot have an optional middle value. AG is Access Group ID. NI is network identifier name.
?contentAnalytics=1 Optional. Returns content analytics hierarchy and collection IDs. (Deprecated)
?showConfiguration=true Optional. Returns current service configuration settings. Scope must be specified to the NI level.

Example 1: Services under AG

https://ws.lumen.com/services/cdn/v1.0/12345

Returns services (and individual NIs) in AG 12345

<?xml version="1.0" encoding="UTF-8"?>
<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation=
“(Undefined variable: Primary.API Schema URI)/services/cdn/v1.0 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1270071184562-8650
</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<services>
<service id=“BBBN56789”>
<serviceResource>/12345/BBBN56789</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id=“cdn.exampleni.com”>
<serviceResource>/12345/BBBN56789/cdn.exampleni.com
</serviceResource>
<product>CACHING</product>
</ni>
<ni …/>
</networkIdentifiers>
</service>
<service>…</service>
</services>
<networkIdentifiers>
<ni id=“sample-live”>
<serviceResource>/12345/BBBN10111/sample-live
</serviceResource>
<product>STREAMING</product>
<type>Live</type>
</ni>
<ni …/>
</networkIdentifiers>
</accessGroup>

Example 2: NIs under a SCID

https://ws.lumen.com/services/cdn/v1.0/12345/BBBN56789

Returns NIs in AG 12345 under SCID BBBN56789.

<?xml version="1.0" encoding="UTF-8"?>
<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation= “(Undefined variable: Primary.API Schema URI)/services/cdn/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1270071184562-8650
</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<services>
<service id=“BBBN56789”>
<serviceResource>/12345/BBBN56789</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id=“cdn.exampleni.com”>
<serviceResource>/12345/BBBN56789/cdn.exampleni.com
</serviceResource>
<product>CACHING</product>
</ni>
<ni …/>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Example 3: NI details

https://ws.lumen.com/services/cdn/v1.0/12345/BBBN56789/cdn.exampleni.com

Returns details on NI cdn.exampleni.com in AG 12345 under SCID BBBN56789.

<?xml version="1.0" encoding="UTF-8"?>
<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation= “(Undefined variable: Primary.API Schema URI)/services/cdn/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1270071184562-8650
</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<services>
<service id=“BBBN56789”>
<serviceResource>/12345/BBBN56789</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id=“cdn.exampleni.com”>
<serviceResource>/12345/BBBN56789/cdn.exampleni.com
</serviceResource>
<product>CACHING</product>
</ni>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Example 4: Content analytics hierarchy for AG

https://ws.lumen.com/services/cdn/v1.0/12345?contentAnalytics=1

Returns Content Analytics-enabled NIs for AG 12345 and their collection detail.

<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation ="(Undefined variable: Primary.API Schema URI)/services/cdn/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>CDNPortal-1283545533522-5690</apiCorrelationId>
<serviceResource>/12345</serviceResource>
<services>
<service id="BBBL12345">
<serviceResource>/12345/BBBL12345</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id="smooth.level3.com">
<serviceResource>/202/BBBZ12345/my.sampleni.com
</serviceResource>
<product>CACHING</product>
<contentAnalytics>
<active>true</active>
<serviceLevel>premium</serviceLevel>
<samplingRate>premium</samplingRate>
<collections>
<collection id="3">
<serviceResource>/202/BBBZ12345/my.sampleni.com/1
</serviceResource>
<pattern>*</pattern>
<token>-</token>
<type>pattern</type>
<active>true</active>
<asn>false</asn>
<detailed>true</detailed>
<lastModified>2009-10-08 15:12:49 +0000
</lastModified>
</collection>
</collections>
</contentAnalytics>
</ni>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Example 5: Show configuration of www.level3.com

https://ws.lumen.com/services/cdn/v1.0/[accessGroupID]/[SCID]/www.lumen.com?showConfiguration=true

Returns configuration settings for www.lumen.com.

<accessGroup id="[accessGroupID]" name="Level 3 Communications, LLC." xsi:noNamespaceSchemaLocation="https://ws.lumen.com/schema/servicesv1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<apiCorrelationId>API-b3dac651-06b7-4b47-8257-eec836b76f50</apiCorrelationId>
<serviceResource>/[accessGroupID]</serviceResource>
<services>
<service id="[SCID]">
<serviceResource>/[accessGroupID]/[SCID]</serviceResource>
<product>CACHING</product>
<networkIdentifiers>
<ni id="www.lumen.com">
<serviceResource>/[accessGroupID]/[SCID]/www.lumen.com</serviceResource>
<product>CACHING</product>
<active>Y</active>
<serviceDetails>
<name>www.lumen.com</name>
<installDate>06/11/2013</installDate>
<aliases>
<primaryAlias>www.lumen.com</primaryAlias>
<secondaryAliases/>
<altIDExtendedAliases/>
</aliases>
<originHostname>v1.lumen.com</originHostname>
<cacheFillProtocol>http</cacheFillProtocol>
<cacheFillPort>80</cacheFillPort>
<altWebRoot/>
<fillHostHeader>v1.lumen.com</fillHostHeader>
<level3Origin>false</level3Origin>
<adminFlags>
<flag name="url_stats">standard</flag>
</adminFlags>
<coserverWideFlags>
<flag name="qshmode">*</flag>
<flag name="mp4_scrubbable">ext=.mp4,start=start,end=end</flag>
</coserverWideFlags>
<ruleBases>
<ruleBase name="Requests to Origin Server"/>
<ruleBase name="Responses from Origin Server"/>
</ruleBases>
</serviceDetails>
</ni>
</networkIdentifiers>
</service>
</services>
</accessGroup>

Possible status and error messages returned to client

Additional return codes and error messages