You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2017/07/21 16:57:08 UTC
[12/44] incubator-trafficcontrol-website git commit: updates rst docs
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
index a8ff4ed..02be25a 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Delivery Service — Traffic Control master documentation </title>
+ <title>Delivery Service — Traffic Control 2.1-dev documentation </title>
@@ -33,10 +33,10 @@
- <link rel="top" title="Traffic Control master documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
- <link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
- <link rel="prev" title="Change Logs" href="changelog.html"/>
+ <link rel="next" title="Delivery Service Regexes" href="deliveryservice_regex.html"/>
+ <link rel="prev" title="/api/1.2/servers/:hostname/configfiles/ats" href="configfiles_ats.html"/>
<script src="_static/js/modernizr.min.js"></script>
@@ -102,12 +102,15 @@
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_install.html">Installing Traffic Ops</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_using.html">Using Traffic Ops</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor.html">Traffic Monitor Administration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li>
@@ -118,10 +121,12 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer’s Guide</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li>
</ul>
@@ -159,7 +164,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control master</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 2.1-dev</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -177,10 +182,10 @@
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="deliveryservice_stats.html" class="btn btn-neutral float-right" title="Delivery Service Statistics">Next <span class="fa fa-arrow-circle-right"></span></a>
+ <a href="deliveryservice_regex.html" class="btn btn-neutral float-right" title="Delivery Service Regexes">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="changelog.html" class="btn btn-neutral" title="Change Logs"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="configfiles_ats.html" class="btn btn-neutral" title="/api/1.2/servers/:hostname/configfiles/ats"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
@@ -192,7 +197,7 @@
<span id="to-api-v12-ds-route"></span><h2>/api/1.2/deliveryservices<a class="headerlink" href="#api-1-2-deliveryservices" title="Permalink to this headline">¶</a></h2>
<p><strong>GET /api/1.2/deliveryservices</strong></p>
<blockquote>
-<div><p>Retrieves all delivery services. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<div><p>Retrieves all delivery services (if admin or ops) or all delivery services assigned to user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Query Parameters</strong></p>
@@ -213,10 +218,18 @@
<td>no</td>
<td>Filter delivery services by CDN ID.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
+<td>no</td>
+<td>Filter delivery services by Profile ID.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>no</td>
<td>Filter delivery services by Type ID.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<td>no</td>
+<td>Filter by logs enabled (true|false).</td>
+</tr>
</tbody>
</table>
<p><strong>Response Properties</strong></p>
@@ -242,11 +255,11 @@
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
-<td>string</td>
+<td>int</td>
<td>Id of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
@@ -261,34 +274,42 @@
<td>string</td>
<td>The display name of the delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<td>int</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<td>array</td>
+<td>Entry points into the CDN for this deliveryservice.</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
<td>string</td>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
-<td>string</td>
+<td>int</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
<li>1: Only route on CZF file hit</li>
@@ -303,16 +324,16 @@ routing to the content by Traffic Router.</p>
<td> </td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
-<td>string</td>
+<td>int</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
@@ -323,7 +344,7 @@ HTTP deliveryservices</td>
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The deliveryservice id (database row number).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
@@ -331,7 +352,7 @@ globalMaxMbps traffic on this deliveryservice.</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
-<td>string</td>
+<td>int</td>
<td> </td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
@@ -348,52 +369,44 @@ globalMaxMbps traffic on this deliveryservice.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
-<td>Description field 1.</td>
+<td>Description field.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
-<td>Description field 2.</td>
+<td>Description field 1.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
-<td>string</td>
-<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
-<td>string</td>
-<td>The set Number of the matchList.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
-<td>string</td>
-<td>The regexp for the matchList.</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
<td>The MID header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
-<td>string</td>
-<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
-<td>string</td>
-<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p>
+<ul class="last simple">
+<li>e.g. 39.7391500 or null</li>
+</ul>
+</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p>
+<ul class="last simple">
+<li>e.g. -104.9847000 or null</li>
+</ul>
+</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -409,7 +422,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
@@ -417,7 +430,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
+<td>int</td>
<td><ul class="first last simple">
<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
@@ -426,7 +439,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
-<td>string</td>
+<td>int</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
@@ -435,7 +448,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
-<td>string</td>
+<td>int</td>
<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
@@ -465,9 +478,17 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
-<td>string</td>
+<td>int</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
<td> </td>
@@ -476,92 +497,82 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
-<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>int</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
<td>string</td>
<td>Unique string that describes this deliveryservice.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre>{
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "ccrDnsTtl": "3600",
- "cdnId": "2",
- "cdnName": "over-the-top",
- "checkPath": "",
- "displayName": "My Cool Delivery Service",
- "dnsBypassCname": "",
- "dnsBypassIp": "",
- "dnsBypassIp6": "",
- "dnsBypassTtl": "30",
- "dscp": "40",
- "edgeHeaderRewrite": null,
- "exampleURLs": [
- "http://edge.foo-ds.foo.bar.net"
- ],
- "geoLimit": "0",
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": "0",
- "globalMaxMbps": null,
- "globalMaxTps": "0",
- "httpBypassFqdn": "",
- "id": "442",
- "infoUrl": "",
- "initialDispersion": "1",
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2016-01-26 08:49:35",
- "logsEnabled": false,
- "longDesc": "",
- "longDesc1": "",
- "longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
- "maxDnsAnswers": "0",
- "midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
- "orgServerFqdn": "http://baz.boo.net",
- "originShield": null,
- "profileDescription": "Content Router for over-the-top",
- "profileId": "5",
- "profileName": "ROUTER_TOP",
- "protocol": "0",
- "qstringIgnore": "1",
- "rangeRequestHandling": "0",
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "signed": false,
- "sslKeyVersion": "0",
- "trRequestHeaders": null,
- "trResponseHeaders": "Access-Control-Allow-Origin: *",
- "type": "HTTP",
- "typeId": "8",
- "xmlId": "foo-ds"
- }
- { .. },
- { .. }
- ]
-}
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="p">],</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="p">}</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
+ <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
</pre></div>
</div>
</div></blockquote>
@@ -570,7 +581,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</div>
<p><strong>GET /api/1.2/deliveryservices/:id</strong></p>
<blockquote>
-<div><p>Retrieves a specific delivery service. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
+<div><p>Retrieves a specific delivery service. If not admin / ops, delivery service must be assigned to user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</p>
<p>Authentication Required: Yes</p>
<p>Role(s) Required: None</p>
<p><strong>Request Route Parameters</strong></p>
@@ -616,11 +627,11 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>Cache URL rule to apply to this delivery service.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td>
-<td>string</td>
+<td>int</td>
<td>Id of the CDN to which the delivery service belongs to.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td>
@@ -635,38 +646,42 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>string</td>
<td>The display name of the delivery service.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassCname</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td>
<td>string</td>
<td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td>
<td>string</td>
<td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td>
+<td>int</td>
<td>The TTL of the DNS bypass response.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">dscp</span></code></td>
+<td>int</td>
<td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td>
<td>string</td>
<td>The EDGE header rewrite actions to perform.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">exampleURLs</span></code></td>
<td>array</td>
<td>Entry points into the CDN for this deliveryservice.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td>
+<td>int</td>
<td><ul class="first simple">
<li>0: None - no limitations</li>
<li>1: Only route on CZF file hit</li>
@@ -676,106 +691,110 @@ globalMaxMbps traffic on this deliveryservice.</td>
routing to the content by Traffic Router.</p>
</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td>
+<td>int</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td>
+<td>int</td>
<td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the
dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td>
+<td>int</td>
<td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded
traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for
HTTP deliveryservices</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td>
<td>string</td>
<td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the
globalMaxMbps traffic on this deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>int</td>
<td>The deliveryservice id (database row number).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td>
<td>string</td>
<td>Use this to add a URL that points to more information about that deliveryservice.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
-<td>string</td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td>
+<td>int</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td>
<td>bool</td>
<td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td>
<td>string</td>
<td> </td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td>
<td>bool</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td>
<td>string</td>
-<td>Description field 1.</td>
+<td>Description field.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td>
<td>string</td>
-<td>Description field 2.</td>
+<td>Description field 1.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td>
<td>string</td>
<td>Description field 2.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">matchList</span></code></td>
<td>array</td>
<td>Array of matchList hashes.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
<td>string</td>
<td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td>
<td>string</td>
<td>The set Number of the matchList.</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td>
<td>string</td>
<td>The regexp for the matchList.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td>
+<td>int</td>
<td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all
available).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td>
<td>string</td>
<td>The MID header rewrite actions to perform.</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
-<td>string</td>
-<td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
-<td>string</td>
-<td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">missLat</span></code></td>
+<td>float</td>
+<td><p class="first">The latitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p>
+<ul class="last simple">
+<li>e.g. 39.7391500 or null</li>
+</ul>
+</td>
</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
-<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLong</span></code></td>
+<td>float</td>
+<td><p class="first">The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup.</p>
+<ul class="last simple">
+<li>e.g. -104.9847000 or null</li>
+</ul>
+</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -791,7 +810,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
-<td>string</td>
+<td>int</td>
<td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td>
@@ -799,7 +818,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td>
-<td>string</td>
+<td>int</td>
<td><ul class="first last simple">
<li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li>
<li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li>
@@ -808,7 +827,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td>
-<td>string</td>
+<td>int</td>
<td><ul class="first last simple">
<li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li>
<li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li>
@@ -817,7 +836,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td>
-<td>string</td>
+<td>int</td>
<td><p class="first">How to treat range requests:</p>
<ul class="last simple">
<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li>
@@ -847,9 +866,17 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td>
-<td>string</td>
+<td>int</td>
<td> </td>
</tr>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td>
+<td>string</td>
+<td>Owning tenant name</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td>
+<td>int</td>
+<td>Owning tenant ID</td>
+</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td>
<td>string</td>
<td> </td>
@@ -858,87 +885,84 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<td>string</td>
<td> </td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
-<td>string</td>
-<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
-<td>string</td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
+<td>int</td>
<td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td>
</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td>
<td>string</td>
<td>Unique string that describes this deliveryservice.</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
- <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
- <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"displayName"</span><span class="p">:</span> <span class="s">"My Cool Delivery Service"</span><span class="p">,</span>
- <span class="s">"dnsBypassCname"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="s">"30"</span><span class="p">,</span>
- <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
- <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
+ <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
+ <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
+ <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
<span class="p">],</span>
- <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"geoProvider"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"442"</span><span class="p">,</span>
- <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"initialDispersion"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 08:49:35"</span><span class="p">,</span>
- <span class="s">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
+ <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.foo-ds</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
- <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
- <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
- <span class="s">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://baz.boo.net"</span><span class="p">,</span>
- <span class="s">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for over-the-top"</span><span class="p">,</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
- <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"ROUTER_TOP"</span><span class="p">,</span>
- <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
- <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"sslKeyVersion"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
- <span class="s">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"trResponseHeaders"</span><span class="p">:</span> <span class="s">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
- <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"foo-ds"</span>
+ <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"39.7391500"</span><span class="p">,</span>
+ <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-104.9847000"</span><span class="p">,</span>
+ <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
+ <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
+ <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
+ <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span>
+ <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
+ <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -950,9 +974,9 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</div>
<p><strong>GET /api/1.2/deliveryservices/:id/servers</strong></p>
<blockquote>
-<div><p>Retrieves properties of CDN Edge servers assigned to a delivery service.</p>
+<div><p>Retrieves properties of CDN EDGE or ORG servers assigned to a delivery service.</p>
<p>Authentication Required: Yes</p>
-<p>Role(s) Required: None</p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user.</p>
<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
@@ -989,7 +1013,7 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
<td>string</td>
@@ -1093,23 +1117,23 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
<td>string</td>
-<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
-<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
+<td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -1125,11 +1149,11 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><em>Status</em></a>).</td>
+<td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -1137,11 +1161,11 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
-<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><em>Types</em></a>).</td>
+<td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
<td>bool</td>
@@ -1150,49 +1174,49 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
+ <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
- <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"CDN-1"</span><span class="p">,</span>
- <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
- <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
- <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
- <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
- <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
- <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
- <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
- <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
- <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
- <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
- <span class="s">"offlineReason"</span><span class="p">:</span> <span class="s">"N/A"</span><span class="p">,</span>
- <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s">"physLocationId"</span><span class="p">:</span> <span class="s">"9"</span><span class="p">,</span>
- <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s">"profileDesc"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
- <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
- <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
- <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
- <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
- <span class="s">"statusId"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
- <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
- <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
- <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
- <span class="s">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
+ <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
+ <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
+ <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
+ <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
+ <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
+ <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
+ <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
+ <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
+ <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
+ <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
+ <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
+ <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
+ <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
+ <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
+ <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
+ <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
@@ -1205,94 +1229,37 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
<div class="line-block">
<div class="line"><br /></div>
</div>
-</div>
-<div class="section" id="health">
-<span id="to-api-v12-ds-health"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2>
-<p><strong>GET /api/1.2/deliveryservices/:id/state</strong></p>
+<p><strong>GET /api/1.2/deliveryservices/:id/servers/unassigned</strong></p>
<blockquote>
-<div><p>Retrieves the failover state for a delivery service.</p>
+<div><p>Retrieves properties of CDN EDGE or ORG servers not assigned to a delivery service.</p>
<p>Authentication Required: Yes</p>
-<p>Role(s) Required: None</p>
-<p><strong>Response Properties</strong></p>
+<p>Role(s) Required: Admin or Operations or delivery service must be assigned to user</p>
+<p><strong>Request Route Parameters</strong></p>
<table border="1" class="docutils">
<colgroup>
-<col width="24%" />
-<col width="12%" />
-<col width="64%" />
+<col width="22%" />
+<col width="13%" />
+<col width="65%" />
</colgroup>
<thead valign="bottom">
-<tr class="row-odd"><th class="head">Parameter</th>
-<th class="head">Type</th>
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">failover</span></code></td>
-<td>hash</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>locations</span></code></td>
-<td>array</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>destination</span></code></td>
-<td>hash</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>location</span></code></td>
-<td>string</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td>
-<td>string</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>configured</span></code></td>
-<td>boolean</td>
-<td> </td>
-</tr>
-<tr class="row-even"><td><code class="docutils literal"><span class="pre">>enabled</span></code></td>
-<td>boolean</td>
-<td> </td>
-</tr>
-<tr class="row-odd"><td><code class="docutils literal"><span class="pre">enabled</span></code></td>
-<td>boolean</td>
-<td> </td>
+<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td>
+<td>yes</td>
+<td>Delivery service ID.</td>
</tr>
</tbody>
</table>
-<p><strong>Response Example</strong></p>
-<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
- <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s">"destination"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s">"type"</span><span class="p">:</span> <span class="s">"DNS"</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s">"enabled
<TRUNCATED>