Repository: incubator-trafficcontrol-website Updated Branches: refs/heads/asf-site 87209db2a -> d0d124f10
updates latest to match master Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/d0d124f1 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/d0d124f1 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/d0d124f1 Branch: refs/heads/asf-site Commit: d0d124f103b09a880bf6d203b581d02093a35438 Parents: 87209db Author: Jeremy Mitchell <jeremy_mitche...@cable.comcast.com> Authored: Wed Apr 12 14:28:42 2017 -0600 Committer: Jeremy Mitchell <jeremy_mitche...@cable.comcast.com> Committed: Wed Apr 12 14:28:42 2017 -0600 ---------------------------------------------------------------------- .../development/traffic_ops_api/v12/job.txt | 136 ++++++ .../development/traffic_ops_api/v12/job.html | 432 +++++++++++++++++++ 2 files changed, 568 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d0d124f1/docs/latest/_sources/development/traffic_ops_api/v12/job.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/job.txt b/docs/latest/_sources/development/traffic_ops_api/v12/job.txt new file mode 100644 index 0000000..be27309 --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v12/job.txt @@ -0,0 +1,136 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v12-job: + +Jobs +==== + +.. _to-api-v12-job-route: + +/api/1.2/jobs +++++++++++++++++++ + +**GET /api/1.2/jobs** + + Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending). + + Authentication Required: Yes + + Role(s) Required: Operations or Admin + + **Request Query Parameters** + + +-----------------+----------+---------------------------------------------------+ + | Name | Required | Description | + +=================+==========+===================================================+ + | ``dsId`` | no | Filter jobs by Delivery Service ID. | + +-----------------+----------+---------------------------------------------------+ + | ``userId`` | no | Filter jobs by User ID. | + +-----------------+----------+---------------------------------------------------+ + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Job id | + +----------------------+--------+-------------------------------------------------+ + |``assetUrl`` | string | URL of the asset to invalidate. | + +----------------------+--------+-------------------------------------------------+ + |``deliveryService`` | string | Unique identifier of the job's DS. | + +----------------------+--------+-------------------------------------------------+ + |``keyword`` | string | Job keyword (PURGE) | + +----------------------+--------+-------------------------------------------------+ + |``parameters`` | string | Parameters associated with the job. | + +----------------------+--------+-------------------------------------------------+ + |``startTime`` | string | Start time of the job. | + +----------------------+--------+-------------------------------------------------+ + |``createdBy`` | string | Username that initiated the job. | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 1 + "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html", + "deliveryService": "foo-bar", + "keyword": "PURGE", + "parameters": "TTL:48h", + "startTime": "2015-05-14 08:56:36-06", + "createdBy": "jdog24" + }, + { + "id": 2 + "assetUrl": "http:\/\/foo-bar.domain.net\/bell.html", + "deliveryService": "foo-bar", + "keyword": "PURGE", + "parameters": "TTL:72h", + "startTime": "2015-05-16 08:56:36-06", + "createdBy": "jdog24" + } + ] + } + +| + + +**GET /api/1.2/jobs/:id** + + Get a job by ID (currently limited to invalidate content (PURGE) jobs). + + Authentication Required: Yes + + Role(s) Required: Operations or Admin + + **Response Properties** + + +----------------------+--------+-------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=================================================+ + |``id`` | int | Job id | + +----------------------+--------+-------------------------------------------------+ + |``assetUrl`` | string | URL of the asset to invalidate. | + +----------------------+--------+-------------------------------------------------+ + |``deliveryService`` | string | Unique identifier of the job's DS. | + +----------------------+--------+-------------------------------------------------+ + |``keyword`` | string | Job keyword (PURGE) | + +----------------------+--------+-------------------------------------------------+ + |``parameters`` | string | Parameters associated with the job. | + +----------------------+--------+-------------------------------------------------+ + |``startTime`` | string | Start time of the job. | + +----------------------+--------+-------------------------------------------------+ + |``createdBy`` | string | Username that initiated the job. | + +----------------------+--------+-------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": 1 + "assetUrl": "http:\/\/foo-bar.domain.net\/taco.html", + "deliveryService": "foo-bar", + "keyword": "PURGE", + "parameters": "TTL:48h", + "startTime": "2015-05-14 08:56:36-06", + "createdBy": "jdog24" + } + ] + } + +| http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/d0d124f1/docs/latest/development/traffic_ops_api/v12/job.html ---------------------------------------------------------------------- diff --git a/docs/latest/development/traffic_ops_api/v12/job.html b/docs/latest/development/traffic_ops_api/v12/job.html new file mode 100644 index 0000000..1602c52 --- /dev/null +++ b/docs/latest/development/traffic_ops_api/v12/job.html @@ -0,0 +1,432 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Jobs — Traffic Control 1.8-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../../index.html"/> + <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> + <link rel="next" title="Parameter" href="parameter.html"/> + <link rel="prev" title="Hardware Info" href="hwinfo.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</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_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_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> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</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 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_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../../index.html">Traffic Control 1.8-dev</a> »</li> + + <li><a href="../../index.html">Developer’s Guide</a> »</li> + + <li><a href="../../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Jobs</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../../_sources/development/traffic_ops_api/v12/job.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="jobs"> +<span id="to-api-v12-job"></span><h1>Jobs<a class="headerlink" href="#jobs" title="Permalink to this headline">¶</a></h1> +<div class="section" id="api-1-2-jobs"> +<span id="to-api-v12-job-route"></span><h2>/api/1.2/jobs<a class="headerlink" href="#api-1-2-jobs" title="Permalink to this headline">¶</a></h2> +<p><strong>GET /api/1.2/jobs</strong></p> +<blockquote> +<div><p>Get all jobs (currently limited to invalidate content (PURGE) jobs) sorted by start time (descending).</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Operations or Admin</p> +<p><strong>Request Query Parameters</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="13%" /> +<col width="65%" /> +</colgroup> +<thead valign="bottom"> +<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">dsId</span></code></td> +<td>no</td> +<td>Filter jobs by Delivery Service ID.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">userId</span></code></td> +<td>no</td> +<td>Filter jobs by User ID.</td> +</tr> +</tbody> +</table> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>int</td> +<td>Job id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td>URL of the asset to invalidate.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td> +<td>string</td> +<td>Unique identifier of the job’s DS.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">keyword</span></code></td> +<td>string</td> +<td>Job keyword (PURGE)</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> +<td>string</td> +<td>Parameters associated with the job.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td>Start time of the job.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">createdBy</span></code></td> +<td>string</td> +<td>Username that initiated the job.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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">"id"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span> + <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span> + <span class="p">},</span> + <span class="p">{</span> + <span class="s2">"id"</span><span class="p">:</span> <span class="mi">2</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/bell.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span> + <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:72h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-16 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.2/jobs/:id</strong></p> +<blockquote> +<div><p>Get a job by ID (currently limited to invalidate content (PURGE) jobs).</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Operations or Admin</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>int</td> +<td>Job id</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">assetUrl</span></code></td> +<td>string</td> +<td>URL of the asset to invalidate.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">deliveryService</span></code></td> +<td>string</td> +<td>Unique identifier of the job’s DS.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">keyword</span></code></td> +<td>string</td> +<td>Job keyword (PURGE)</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">parameters</span></code></td> +<td>string</td> +<td>Parameters associated with the job.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">startTime</span></code></td> +<td>string</td> +<td>Start time of the job.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">createdBy</span></code></td> +<td>string</td> +<td>Username that initiated the job.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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">"id"</span><span class="p">:</span> <span class="mi">1</span> + <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">"http:\/\/foo-bar.domain.net\/taco.html"</span><span class="p">,</span> + <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"foo-bar"</span><span class="p">,</span> + <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span> + <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:48h"</span><span class="p">,</span> + <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-05-14 08:56:36-06"</span><span class="p">,</span> + <span class="s2">"createdBy"</span><span class="p">:</span> <span class="s2">"jdog24"</span> + <span class="p">}</span> + <span class="p">]</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="parameter.html" class="btn btn-neutral float-right" title="Parameter">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="hwinfo.html" class="btn btn-neutral" title="Hardware Info"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../../', + VERSION:'1.8-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../../_static/jquery.js"></script> + <script type="text/javascript" src="../../../_static/underscore.js"></script> + <script type="text/javascript" src="../../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
