Alert.png The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @ egi.eu.

Difference between revisions of "GOCDB/PI/get downtime method"

From EGIWiki
< GOCDB‎ | PI
Jump to navigation Jump to search
 
(19 intermediate revisions by 4 users not shown)
Line 7: Line 7:
{| {{egi-table}}  
{| {{egi-table}}  
|-
|-
| '''Description''' || Returns a list of EGI downtimes for sites and service endpoints
| '''Description''' || Returns a list of service downtimes with each downtime duplicated for each affected service.
|-
|-
| '''Protection Level''' || Public (level 1)  
| '''Protection Level''' || Public (level 1)  
Line 14: Line 14:
=== Entry point ===
=== Entry point ===


https://goc.egi.eu/gocdbpi/public/?method=get_downtime
https://goc.egi.eu/gocdbpi/public/?method=get_downtime&ongoing_only=yes


=== parameters ===
=== parameters ===
Line 25: Line 25:
| ongoing_only || Limit results to current ongoing downtimes || yes/no || no || ?method=get_downtime&ongoing_only=yes  
| 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 YYY-MM-DD format || 1970-01-01 || ?method=get_downtime&startdate=2008-12-08  
| 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 YYY-MM-DD format || 2024-12-31 || ?method=get_downtime&enddate=2008-12-14  
| 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  
|- valign="top"
|- valign="top"
| windowstart/windowend || limit results to current time window (including downtimes that<br> appear in this window, even if they start before or end after) || date in YYY-MM-DD format || 1970-01-01/2024-12-31 || ?method=get_downtime&windowstart=2008-12-08&windowend=2008-12-15  
| windowstart/windowend || limit results to downtimes that cross into the time window (includes downtimes <br> 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  
| scope  
| Show only downtimes with the requested scope-tags (Local and EGI are currently the only available scopes)
| 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. '&amp;scope='
| A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&amp;scope='
| EGI
| EGI
Line 42: Line 42:
| all
| all
| &nbsp;?method=get_downtime&amp;scope=Local,EGI&scope_match=any
| &nbsp;?method=get_downtime&amp;scope=Local,EGI&scope_match=any
|-
| site_extensions
| Limits downtime results by the key pairs of the affected site
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| none
| &nbsp;?method=get_downtime&amp;site_extensions=(KeyName=KeyValue)
|-
| service_extensions
| Limits downtime results by the key pairs of the affected services
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| none
| &nbsp;?method=get_downtime&amp;service_extensions=(KeyName=KeyValue)
<!--|-
| <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>
| <strike>Postive integer (increment and re-issue query for next page of results)</strike>
| <strike>none</strike>
| <strike>&nbsp;?method=get_downtime&amp;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]
|
|
|-
|-
|}
|}
Line 52: Line 77:


=== Output Example ===
=== Output Example ===
<source lang="XML">
<Source Lang="XML">
<?xml version="1.0"?>
<?xml version="1.0"?>
<results>
<results>
   <DOWNTIME ID="12251" PRIMARY_KEY="90753G0" CLASSIFICATION="SCHEDULED">
   <DOWNTIME ID="15833" PRIMARY_KEY="94355G0" CLASSIFICATION="UNSCHEDULED">
  <PRIMARY_KEY>90753G0</PRIMARY_KEY>
    <PRIMARY_KEY>94355G0</PRIMARY_KEY>
  <HOSTNAME>goc.egi.eu</HOSTNAME>
    <HOSTNAME>goc.egi.eu</HOSTNAME>
  <SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
    <SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
  <ENDPOINT>goc.egi.euegi.GOCDB</ENDPOINT>
    <ENDPOINT>goc.egi.euegi.GOCDB</ENDPOINT>
  <HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
    <HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
  <GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Downtimeid=12251</GOCDB_PORTAL_URL>  
    <GOCDB_PORTAL_URL>
  <SEVERITY>OUTAGE</SEVERITY>
        https://localhost/portal/index.php?Page_Type=Downtime amp; id=15833
  <DESCRIPTION>Oracle DB server upgrade</DESCRIPTION>
    </GOCDB_PORTAL_URL>
  <INSERT_DATE>1384162347</INSERT_DATE>
    <AFFECTED_ENDPOINTS>
  <START_DATE>1384336800</START_DATE>
        <ENDPOINT>
  <END_DATE>1384340400</END_DATE>
            <ID>6246</ID>
  <FORMATED_START_DATE>2013-11-13 10:00</FORMATED_START_DATE>
            <NAME>Portal endpoint</NAME>
  <FORMATED_END_DATE>2013-11-13 11:00</FORMATED_END_DATE></DOWNTIME>
            <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>
</results>
</source>
</Source>
<!--
  <DOWNTIME ID="1505022" PRIMARY_KEY="14421G0" CLASSIFICATION="SCHEDULED">
  <PRIMARY_KEY>14421G0</PRIMARY_KEY>
  <SITENAME/>
  <HOSTNAME>
    ce.phy.bg.ac.yu
  </HOSTNAME>
  <SERVICE_TYPE>CE</SERVICE_TYPE>
  <ENDPOINT>
    ce.phy.bg.ac.yuCE
  </ENDPOINT>
  <HOSTED_BY>
    AEGIS01-PHY-SCL
  </HOSTED_BY>
  <SEVERITY>AT RISK</SEVERITY>
  <DESCRIPTION>
    downtime at node level
  </DESCRIPTION>
  <INSERT_DATE>
    1181800100
  </INSERT_DATE>
  <START_DATE>
    1181809800
  </START_DATE>
  <END_DATE>
    1181820600
  </END_DATE>
  <FORMATED_START_DATE>
    2007-06-14 08:30
  </FORMATED_START_DATE>
  <FORMATED_END_DATE>
    2007-06-14 11:30
  </FORMATED_END_DATE>
  </DOWNTIME>
</results>-->


[[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]]
[[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]]

Latest revision as of 14: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>

Back to GOCDB technical Documentation main page