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 nested services method"

From EGIWiki
< GOCDB‎ | PI
Jump to navigation Jump to search
 
(11 intermediate revisions by 3 users not shown)
Line 19: Line 19:


{| {{egi-table}}  
{| {{egi-table}}  
! parameter !! effect !! format/value(s) !! default !! example
! parameter !! effect !! format/value(s) !! default !! examples
|- valign="top"
|- valign="top"
|topentity || Limit results to downtimes below given entity || any NGI (ROC), country, sitename or node hostname || EGEE || ?method=get_downtime_nested_services&topentity=SouthEasternEurope<br> ?method=get_downtime&topentity=Portugal<br> ?method=get_downtime&topentity=RAL-LCG2<br> ?method=get_downtime_nested_services&topentity=ce.mysite.com<br>
|topentity || Limit results to downtimes below given entity || any NGI (ROC), country, sitename or node hostname || EGEE || ?method=get_downtime_nested_services&topentity=SouthEasternEurope<br><br> ?method=get_downtime_nested_services&topentity=Portugal<br><br> ?method=get_downtime_nested_services&topentity=RAL-LCG2<br><br> ?method=get_downtime_nested_services&topentity=ce.mysite.com<br>
|-
|-
| ongoing_only || Limit results to current ongoing downtimes || yes/no || no || ?method=get_downtime_nested_services&ongoing_only=yes  
| ongoing_only || Limit results to current ongoing downtimes || yes/no || no || ?method=get_downtime_nested_services&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_nested_services&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_nested_services&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_nested_services&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_nested_services&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_nested_services&windowstart=2008-12-08&windowend=2008-12-15  
| windowstart/windowend || limit results to downtimes that cross into the time window<br/> (includes downtimes that start before or end after window) || dates in YYYY-MM-DD format || 1970-01-01/2024-12-31 || ?method=get_downtime_nested_services&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 sites with the requested scope-tags - 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 47: Line 47:
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| none
| none
| &nbsp;?method=get_downtime&amp;site_extensions=(KeyName=KeyValue)
| &nbsp;?method=get_downtime_nested_services&amp;site_extensions=(KeyNameOfSiteExtProp=KeyValue)
|-
|-
| service_extensions
| service_extensions
Line 53: Line 53:
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism]
| none
| none
| &nbsp;?method=get_downtime&amp;service_extensions=(KeyName=KeyValue)
| &nbsp;?method=get_downtime_nested_services&amp;service_extensions=(KeyNameOfServExtProp=KeyValue)
<!--
|-
|-
| page
| <strike>page</strike>
| Limits the number of returned results to the page limit (1000)
| <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>
| Postive integer (increment and re-issue query for next page of results)
| <strike>Postive integer (increment and re-issue query for next page of results)</strike>
| none
| <strike>none</strike>
| &nbsp;?method=get_downtime&amp;page=1
| <strike>&nbsp;?method=get_downtime_nested_services&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 70: Line 79:


=== Output Example ===
=== Output Example ===
<Source lang="XML">
<results>
<results>
     <DOWNTIME ID="12501" PRIMARY_KEY="91003G0" CLASSIFICATION="SCHEDULED">
     <DOWNTIME ID="15853" PRIMARY_KEY="94375G0" CLASSIFICATION="UNSCHEDULED">
         <SEVERITY>OUTAGE</SEVERITY>
         <SEVERITY>WARNING</SEVERITY>
         <DESCRIPTION>upgrading WNs and SE</DESCRIPTION>
         <DESCRIPTION>test</DESCRIPTION>
         <INSERT_DATE>1385387749</INSERT_DATE>
         <INSERT_DATE>1422358770</INSERT_DATE>
         <START_DATE>1385510400</START_DATE>
         <START_DATE>1422358680</START_DATE>
         <END_DATE>1386115200</END_DATE>
         <END_DATE>1422362280</END_DATE>
         <FORMATED_START_DATE>2013-11-27 00:00</FORMATED_START_DATE>
         <FORMATED_START_DATE>2015-01-27 11:38</FORMATED_START_DATE>
         <FORMATED_END_DATE>2013-12-04 00:00</FORMATED_END_DATE>
         <FORMATED_END_DATE>2015-01-27 12:38</FORMATED_END_DATE>
         <GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Downtime%26id=12501</GOCDB_PORTAL_URL>
         <GOCDB_PORTAL_URL>
            https://localhost/portal/index.php?Page_Type=Downtime amp; id=15853
        </GOCDB_PORTAL_URL>
         <SERVICES>
         <SERVICES>
             <SERVICE>
             <SERVICE>
                 <PRIMARY_KEY>768</PRIMARY_KEY>
                 <PRIMARY_KEY>4180G0</PRIMARY_KEY>
                 <HOSTNAME>lcg-ce05.hep.ucl.ac.uk</HOSTNAME>
                 <HOSTNAME>goc.egi.eu</HOSTNAME>
                 <SERVICE_TYPE>APEL</SERVICE_TYPE>
                 <SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
                 <ENDPOINT>lcg-ce05.hep.ucl.ac.ukAPEL</ENDPOINT>
                 <ENDPOINT>goc.egi.euegi.GOCDB</ENDPOINT>
                 <HOSTED_BY>UKI-LT2-UCL-HEP</HOSTED_BY>
                 <HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
            </SERVICE>
                <AFFECTED_ENDPOINTS>
            <SERVICE>
                    <ENDPOINT>
                <PRIMARY_KEY>2038</PRIMARY_KEY>
                        <ID>6246</ID>
                <HOSTNAME>lcg-bdii01.hep.ucl.ac.uk</HOSTNAME>
                        <NAME>Portal endpoint</NAME>
                <SERVICE_TYPE>Site-BDII</SERVICE_TYPE>
                        <URL>https://gocdb-test.esc.rl.ac.uk/portal</URL>
                <ENDPOINT>lcg-bdii01.hep.ucl.ac.ukSite-BDII</ENDPOINT>
                        <INTERFACENAME>egi.GOCDB</INTERFACENAME>
                <HOSTED_BY>UKI-LT2-UCL-HEP</HOSTED_BY>
                    </ENDPOINT>
            </SERVICE>
                    <ENDPOINT>
            <SERVICE>
                        <ID>6247</ID>
                <PRIMARY_KEY>2674</PRIMARY_KEY>
                        <NAME>PI endpoint</NAME>
                <HOSTNAME>lcg-ce05.hep.ucl.ac.uk</HOSTNAME>
                        <URL>https://gocdb-test.esc.rl.ac.uk/gocdbpi</URL>
                <SERVICE_TYPE>CREAM-CE</SERVICE_TYPE>
                        <INTERFACENAME>egi.GOCDB</INTERFACENAME>
                <ENDPOINT>lcg-ce05.hep.ucl.ac.ukCREAM-CE</ENDPOINT>
                    </ENDPOINT>
                <HOSTED_BY>UKI-LT2-UCL-HEP</HOSTED_BY>
                 </AFFECTED_ENDPOINTS>
            </SERVICE>
            <SERVICE>
                <PRIMARY_KEY>3395</PRIMARY_KEY>
                <HOSTNAME>lcg-dpm01.hep.ucl.ac.uk</HOSTNAME>
                <SERVICE_TYPE>SRM</SERVICE_TYPE>
                <ENDPOINT>lcg-dpm01.hep.ucl.ac.ukSRM</ENDPOINT>
                 <HOSTED_BY>UKI-LT2-UCL-HEP</HOSTED_BY>
             </SERVICE>
             </SERVICE>
         </SERVICES>
         </SERVICES>
     </DOWNTIME>
     </DOWNTIME>
</results>
</results>
</Source>


[[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:21, 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_nested_services

Description Returns a list of service downtimes with affected services nested as children of the downtime.
Protection Level Public (level 1)

Entry point

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

parameters

parameter effect format/value(s) default examples
topentity Limit results to downtimes below given entity any NGI (ROC), country, sitename or node hostname EGEE ?method=get_downtime_nested_services&topentity=SouthEasternEurope

?method=get_downtime_nested_services&topentity=Portugal

?method=get_downtime_nested_services&topentity=RAL-LCG2

?method=get_downtime_nested_services&topentity=ce.mysite.com
ongoing_only Limit results to current ongoing downtimes yes/no no ?method=get_downtime_nested_services&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_nested_services&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_nested_services&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_nested_services&windowstart=2008-12-08&windowend=2008-12-15
scope Show only sites with the requested scope-tags - 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_nested_services&scope=Local
scope_match Match 'all' or 'any' of the specified scope-tags 'all' or 'any' all  ?method=get_downtime_nested_services&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_nested_services&site_extensions=(KeyNameOfSiteExtProp=KeyValue)
service_extensions Limits downtime results by the key pairs of the affected services See Extensions Mechanism none  ?method=get_downtime_nested_services&service_extensions=(KeyNameOfServExtProp=KeyValue)
Docs for cursor params coming soon. Limit results and use cursor paging to iterate over all results See here for info


Output Example

<results>
    <DOWNTIME ID="15853" PRIMARY_KEY="94375G0" CLASSIFICATION="UNSCHEDULED">
        <SEVERITY>WARNING</SEVERITY>
        <DESCRIPTION>test</DESCRIPTION>
        <INSERT_DATE>1422358770</INSERT_DATE>
        <START_DATE>1422358680</START_DATE>
        <END_DATE>1422362280</END_DATE>
        <FORMATED_START_DATE>2015-01-27 11:38</FORMATED_START_DATE>
        <FORMATED_END_DATE>2015-01-27 12:38</FORMATED_END_DATE>
        <GOCDB_PORTAL_URL>
            https://localhost/portal/index.php?Page_Type=Downtime amp; id=15853
        </GOCDB_PORTAL_URL>
        <SERVICES>
            <SERVICE>
                <PRIMARY_KEY>4180G0</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>
                <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>
            </SERVICE>
        </SERVICES>
    </DOWNTIME>
</results>

Back to GOCDB technical Documentation main page