Difference between revisions of "GOCDB/PI/get downtime method"
Jump to navigation
Jump to search
m (→parameters) |
|||
(3 intermediate revisions by one other user not shown) | |||
Line 32: | Line 32: | ||
|- | |- | ||
| scope | | scope | ||
| Show only downtimes where the service defines the requested scope-tag(s) | | Show only downtimes where the service defines the requested scope-tag(s). A list of currently supported scope tags can be found [https://goc.egi.eu/portal/index.php?Page_Type=Scope_Help here]. | ||
| A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&scope=' | | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&scope=' | ||
| EGI | | EGI | ||
Line 54: | Line 54: | ||
| none | | none | ||
| ?method=get_downtime&service_extensions=(KeyName=KeyValue) | | ?method=get_downtime&service_extensions=(KeyName=KeyValue) | ||
|- | <!--|- | ||
| <strike>page</strike> | | <strike>page</strike> | ||
| <b>Deprecated</b> Please don't use. Offset based paging will be replaced by cursor based paging in a future gocdb release. <strike>Limits the number of returned results to the page limit (1000)</strike> | | <b>Deprecated</b> Please don't use. Offset based paging will be replaced by cursor based paging in a future gocdb release. <strike>Limits the number of returned results to the page limit (1000)</strike> | ||
Line 60: | Line 60: | ||
| <strike>none</strike> | | <strike>none</strike> | ||
| <strike> ?method=get_downtime&page=1</strike> | | <strike> ?method=get_downtime&page=1</strike> | ||
--> | |||
|- | |||
| Docs for cursor params coming soon. | |||
| Limit results and use cursor paging to iterate over all results | |||
| [https://wiki.egi.eu/wiki/GOCDB/notifications#Optional_Cursor_Paging_on_Read_API See here for info] | |||
| | |||
| | |||
|- | |- | ||
|} | |} |
Latest revision as of 15:20, 16 December 2016
Main | EGI.eu operations services | Support | Documentation | Tools | Activities | Performance | Technology | Catch-all Services | Resource Allocation | Security |
GOC DB menu: | Home • | Documentation Index • |
Method: get_downtime
Description | Returns a list of service downtimes with each downtime duplicated for each affected service. |
Protection Level | Public (level 1) |
Entry point
https://goc.egi.eu/gocdbpi/public/?method=get_downtime&ongoing_only=yes
parameters
parameter | effect | format/value(s) | default | example |
---|---|---|---|---|
topentity | Limit results to downtimes below given entity | any NGI (ROC), country, sitename or node hostname | EGEE | ?method=get_downtime&topentity=SouthEasternEurope ?method=get_downtime&topentity=Portugal ?method=get_downtime&topentity=RAL-LCG2 ?method=get_downtime&topentity=ce.mysite.com |
ongoing_only | Limit results to current ongoing downtimes | yes/no | no | ?method=get_downtime&ongoing_only=yes |
startdate | Limit results to downtimes that start after specified date | date in YYYY-MM-DD format | 1970-01-01 | ?method=get_downtime&startdate=2008-12-08 |
enddate | limit results to downtimes that end before specified date | date in YYYY-MM-DD format | 2024-12-31 | ?method=get_downtime&enddate=2008-12-14 |
windowstart/windowend | limit results to downtimes that cross into the time window (includes downtimes that start before or end after window) |
dates in YYYY-MM-DD format | 1970-01-01/2024-12-31 | ?method=get_downtime&windowstart=2008-12-08&windowend=2008-12-15 |
scope | Show only downtimes where the service defines the requested scope-tag(s). A list of currently supported scope tags can be found here. | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&scope=' | EGI | ?method=get_downtime&scope=Local |
scope_match | Match 'all' or 'any' of the specified scope-tags | 'all' or 'any' | all | ?method=get_downtime&scope=Local,EGI&scope_match=any |
site_extensions | Limits downtime results by the key pairs of the affected site | See Extensions Mechanism | none | ?method=get_downtime&site_extensions=(KeyName=KeyValue) |
service_extensions | Limits downtime results by the key pairs of the affected services | See Extensions Mechanism | none | ?method=get_downtime&service_extensions=(KeyName=KeyValue) |
Docs for cursor params coming soon. | Limit results and use cursor paging to iterate over all results | See here for info |
Output Example
<?xml version="1.0"?>
<results>
<DOWNTIME ID="15833" PRIMARY_KEY="94355G0" CLASSIFICATION="UNSCHEDULED">
<PRIMARY_KEY>94355G0</PRIMARY_KEY>
<HOSTNAME>goc.egi.eu</HOSTNAME>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<ENDPOINT>goc.egi.euegi.GOCDB</ENDPOINT>
<HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
<GOCDB_PORTAL_URL>
https://localhost/portal/index.php?Page_Type=Downtime amp; id=15833
</GOCDB_PORTAL_URL>
<AFFECTED_ENDPOINTS>
<ENDPOINT>
<ID>6246</ID>
<NAME>Portal endpoint</NAME>
<URL>https://gocdb-test.esc.rl.ac.uk/portal</URL>
<INTERFACENAME>egi.GOCDB</INTERFACENAME>
</ENDPOINT>
<ENDPOINT>
<ID>6247</ID>
<NAME>PI endpoint</NAME>
<URL>https://gocdb-test.esc.rl.ac.uk/gocdbpi</URL>
<INTERFACENAME>egi.GOCDB</INTERFACENAME>
</ENDPOINT>
</AFFECTED_ENDPOINTS>
<SEVERITY>WARNING</SEVERITY>
<DESCRIPTION>test</DESCRIPTION>
<INSERT_DATE>1421829383</INSERT_DATE>
<START_DATE>1421861700</START_DATE>
<END_DATE>1421865300</END_DATE>
<FORMATED_START_DATE>2015-01-21 17:35</FORMATED_START_DATE>
<FORMATED_END_DATE>2015-01-21 18:35</FORMATED_END_DATE>
</DOWNTIME>
</results>