Commit 0f80459f authored by Jerome Touvier's avatar Jerome Touvier
Browse files

Merge branch 'update' into 'master'

update doc

See merge request !32
parents b212081f abf5aa3d
Pipeline #56076 passed with stage
in 40 seconds
......@@ -2,6 +2,7 @@
This service provides access to the RESIF-DC statistics.
## Query usage
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
......@@ -39,6 +40,16 @@ This service provides access to the RESIF-DC statistics.
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect</a>
### timeseries request output example
time country bytes clients\
2020-01-06 AT 116539392 1\
2020-01-06 AU 12664213504 1\
...
The 'time' field represents the first day of a period of one week.
## Detailed descriptions of each query parameter
| Parameter | Example | Discussion |
......@@ -55,7 +66,7 @@ This service provides access to the RESIF-DC statistics.
### Additional parameters for country, send, and timeseries request options
| Parameter | Example | Discussion |
| :--------- | :------- | :------------------------------------------------------------------------------ |
| country | FR,GB | Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2). |
| country | FR,GB | Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2). If country=all the sum on all country is returned. |
| media | seedlink | Protocol used to request data. Allowed values : all (the default), dataselect, and seedlink |
### Additional parameters for storage request option
......@@ -88,3 +99,11 @@ This service provides access to the RESIF-DC statistics.
ss :: two-digit number of seconds (00 through 59)
ssssss :: one to six-digit number of microseconds (0 through 999999)
## Source code
<a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics</a>
## Report a problem
<a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/</a>
......@@ -2,6 +2,7 @@
Ce service donne accès aux statistiques de RESIF-DC.
## Utilisation de la requête
/query? (request-options) [channel-options] [date-options] [storage-options] [send-options] [output-options]
......@@ -39,6 +40,16 @@ Ce service donne accès aux statistiques de RESIF-DC.
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect</a>
### Exemple de sortie avec la requête timeseries
time country bytes clients\
2020-01-06 AT 116539392 1\
2020-01-06 AU 12664213504 1\
...
La colonne 'time' représente le premier jour d'une période d'une semaine.
## Descriptions détaillées de chaque paramètre de la requête
| Paramètre | Exemple | Discussion |
......@@ -49,13 +60,13 @@ Ce service donne accès aux statistiques de RESIF-DC.
| cha[nnel] | HHZ | Code de canal. Ce paramètre accepte les jokers. |
| start[time] | 2010-01-10T00:00:00 | Donne les réponses qui couvrent la période après la date donnée incluse. |
| end[time] | 2011-02-11T01:00:00 | Donne les réponses qui couvrent la période avant la date donnée incluse. |
| format | text | Format de sortie. Valeurs autorisées : text, json et csv. |
| format | text | Format de sortie. Valeurs autorisées : text, json et csv. |
| request | send | Type de la statistique demandée. Valeurs autorisées : <br> - __country__ : nombre de requêtes passées par pays <br> - __map__ : une carte avec le nombre de requêtes provenant de chaque pays <br> - __send__ : volume de données distribuées par protocoles <br> - __storage__ : quantité de données stockées brutes et validées <br> - __timeseries__ : produit une série temporelle avec en colonne le pays, le nombre et la taille cumulés des requêtes |
### Options supplémentaires spécifiques aux requêtes country, send et timeseries
| Paramètre | Exemple | Discussion |
| :--------- | :------ | :------------------------------------------------------------------------------ |
| country | FR,GB | Filtre les réponses avec une liste des pays d'origine. Utilisez l'abréviation en deux lettres du pays (ISO 3166-1 alpha-2). |
| country | FR,GB | Filtre les réponses avec une liste des pays d'origine. Utilisez l'abréviation en deux lettres du pays (ISO 3166-1 alpha-2). Si country=all la somme sur tous les pays est renvoyée. |
| media | seedlink | Protocoles utilisés pour la requête. Valeurs autorisées : all (par défaut), dataselect et seedlink |
### Options supplémentaires spécifiques à la requête storage
......@@ -88,3 +99,11 @@ Ce service donne accès aux statistiques de RESIF-DC.
ss :: deux chiffres des secondes (00 à 59)
ssssss :: un à six chiffres des microsecondes en base décimale (0 à 999999)
## Code source
<a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics</a>
## Reporter un problème
<a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/</a>
......@@ -47,6 +47,12 @@ output-options :: [format=&lt;csv|json|text&gt;]
<p><a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01</a><br />
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01&amp;country=all</a><br />
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01&amp;country=all&amp;media=dataselect</a></p>
<h3 id="exemple-de-sortie-avec-la-requête-timeseries">Exemple de sortie avec la requête timeseries</h3>
<p>time country bytes clients<br />
2020-01-06 AT 116539392 1<br />
2020-01-06 AU 12664213504 1<br />
</p>
<p>La colonne ‘time’ représente le premier jour d’une période d’une semaine.</p>
<h2 id="descriptions-détaillées-de-chaque-paramètre-de-la-requête">Descriptions détaillées de chaque paramètre de la requête</h2>
<table>
<colgroup>
......@@ -122,7 +128,7 @@ output-options :: [format=&lt;csv|json|text&gt;]
<tr class="odd">
<td style="text-align: left;">country</td>
<td style="text-align: left;">FR,GB</td>
<td style="text-align: left;">Filtre les réponses avec une liste des pays d’origine. Utilisez l’abréviation en deux lettres du pays (ISO 3166-1 alpha-2).</td>
<td style="text-align: left;">Filtre les réponses avec une liste des pays d’origine. Utilisez l’abréviation en deux lettres du pays (ISO 3166-1 alpha-2). Si country=all la somme sur tous les pays est renvoyée.</td>
</tr>
<tr class="even">
<td style="text-align: left;">media</td>
......@@ -179,5 +185,9 @@ hh :: deux chiffres de l&#39;heure (00 à 23)
mm :: deux chiffres des minutes (00 à 59)
ss :: deux chiffres des secondes (00 à 59)
ssssss :: un à six chiffres des microsecondes en base décimale (0 à 999999)</code></pre>
<h2 id="code-source">Code source</h2>
<p><a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics</a></p>
<h2 id="reporter-un-problème">Reporter un problème</h2>
<p><a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/</a></p>
</body>
</html>
......@@ -47,6 +47,12 @@ output-options :: [format=&lt;csv|json|text&gt;]
<p><a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01</a><br />
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01&amp;country=all</a><br />
<a href="http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&starttime=2020-01-01&country=all&media=dataselect">http://ws.resif.fr/resifws/statistics/1/query?request=timeseries&amp;starttime=2020-01-01&amp;country=all&amp;media=dataselect</a></p>
<h3 id="timeseries-request-output-example">timeseries request output example</h3>
<p>time country bytes clients<br />
2020-01-06 AT 116539392 1<br />
2020-01-06 AU 12664213504 1<br />
</p>
<p>The ‘time’ field represents the first day of a period of one week.</p>
<h2 id="detailed-descriptions-of-each-query-parameter">Detailed descriptions of each query parameter</h2>
<table>
<colgroup>
......@@ -122,7 +128,7 @@ output-options :: [format=&lt;csv|json|text&gt;]
<tr class="odd">
<td style="text-align: left;">country</td>
<td style="text-align: left;">FR,GB</td>
<td style="text-align: left;">Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2).</td>
<td style="text-align: left;">Data are filtered to their country of origin. Use the country code (ISO 3166-1 alpha-2). If country=all the sum on all country is returned.</td>
</tr>
<tr class="even">
<td style="text-align: left;">media</td>
......@@ -179,5 +185,9 @@ hh :: two-digit hour (00 through 23)
mm :: two-digit number of minutes (00 through 59)
ss :: two-digit number of seconds (00 through 59)
ssssss :: one to six-digit number of microseconds (0 through 999999)</code></pre>
<h2 id="source-code">Source code</h2>
<p><a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics</a></p>
<h2 id="report-a-problem">Report a problem</h2>
<p><a href="https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/">https://gricad-gitlab.univ-grenoble-alpes.fr/OSUG/RESIF/ws-statistics/-/issues/</a></p>
</body>
</html>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment