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

From EGIWiki
< GOCDB‎ | PI
Jump to: navigation, search
(XML schema)
(parameters)
 
(5 intermediate revisions by 2 users not shown)
Line 24: Line 24:
 
|-
 
|-
 
| scope  
 
| scope  
| Show only downtimes that affect service endpoints 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 34: Line 34:
 
| all
 
| all
 
| &nbsp;?method=get_downtime_to_broadcast&amp;scope=Local,EGI&scope_match=any
 
| &nbsp;?method=get_downtime_to_broadcast&amp;scope=Local,EGI&scope_match=any
 +
|-
 +
| 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 45: Line 51:
  
 
=== Output Example ===
 
=== Output Example ===
 
+
<Source Lang="XML">
 
  <?xml version="1.0"?>
 
  <?xml version="1.0"?>
 
  <results>
 
  <results>
  <DOWNTIME ID="57205437" PRIMARY_KEY="14101G0" CLASSIFICATION="SCHEDULED">
+
    <DOWNTIME ID="15853" PRIMARY_KEY="94375G0" CLASSIFICATION="UNSCHEDULED">
  <PRIMARY_KEY>14101G0</PRIMARY_KEY>
+
        <PRIMARY_KEY>94375G0</PRIMARY_KEY>
  <SITENAME>wuppertalprod</SITENAME>
+
        <SITENAME>GRIDOPS-GOCDB</SITENAME>
  <HOSTNAME/>
+
        <HOSTNAME>goc.egi.eu</HOSTNAME>
  <SERVICE_TYPE/>
+
        <SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
  <HOSTED_BY/>
+
        <HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
  <SEVERITY>OUTAGE</SEVERITY>
+
        <GOCDB_PORTAL_URL>
  <DESCRIPTION>dCache upgrade</DESCRIPTION>
+
            https://localhost/portal/index.php?Page_Type=Downtime amp; id=15853
  <GOCDB_PORTAL_URL>
+
        </GOCDB_PORTAL_URL>
    <nowiki>https://next.gocdb.eu/portal/index.php?Page_Type=View_Object&object_id=1133&grid_id=0</nowiki>
+
        <AFFECTED_ENDPOINTS>
  </GOCDB_PORTAL_URL>
+
            <ENDPOINT>
  <INSERT_DATE>1263908942</INSERT_DATE>
+
                <ID>6246</ID>
  <START_DATE>1264154400</START_DATE>
+
                <NAME>Portal endpoint</NAME>
  <END_DATE>1264158000</END_DATE>
+
                <URL>https://gocdb-test.esc.rl.ac.uk/portal</URL>
  <REMINDER_START_DOWNTIME>3155760000</REMINDER_START_DOWNTIME>
+
                <INTERFACENAME>egi.GOCDB</INTERFACENAME>
  <BROADCASTING_START_DOWNTIME/>
+
            </ENDPOINT>
  </DOWNTIME>
+
            <ENDPOINT>
</results>
+
                <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>1422358770</INSERT_DATE>
 +
        <START_DATE>1422358680</START_DATE>
 +
        <END_DATE>1422362280</END_DATE>
 +
        <REMINDER_START_DOWNTIME>1422358770</REMINDER_START_DOWNTIME>
 +
        <BROADCASTING_START_DOWNTIME/> <!-- intentionally has no value to mirror gocdbv4 behaviour -->
 +
    </DOWNTIME>
 +
</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:25, 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_to_broadcast

Description Returns the list of downtimes recently declared with notification settings for CIC portal downtime notification service
Protection Level Protected (level 2)

Entry point

https://goc.egi.eu/gocdbpi/private/?method=get_downtime_to_broadcast

parameters

parameter effect format/value(s) default example
interval Limit results to downtimes that have been inserted in the past interval days number 1 ?method=get_downtime_to_broadcast&interval=7
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_to_broadcast&scope=Local
scope_match Match 'all' or 'any' of the specified scope-tags 'all' or 'any' all  ?method=get_downtime_to_broadcast&scope=Local,EGI&scope_match=any
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="15853" PRIMARY_KEY="94375G0" CLASSIFICATION="UNSCHEDULED">
        <PRIMARY_KEY>94375G0</PRIMARY_KEY>
        <SITENAME>GRIDOPS-GOCDB</SITENAME>
        <HOSTNAME>goc.egi.eu</HOSTNAME>
        <SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
        <HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
        <GOCDB_PORTAL_URL>
            https://localhost/portal/index.php?Page_Type=Downtime amp; id=15853
        </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>1422358770</INSERT_DATE>
        <START_DATE>1422358680</START_DATE>
        <END_DATE>1422362280</END_DATE>
        <REMINDER_START_DOWNTIME>1422358770</REMINDER_START_DOWNTIME>
        <BROADCASTING_START_DOWNTIME/> <!-- intentionally has no value to mirror gocdbv4 behaviour -->
    </DOWNTIME>
</results>

Back to GOCDB technical Documentation main page