Difference between revisions of "GOCDB/PI/get downtime to broadcast method"
Jump to navigation
Jump to search
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{Template:Op menubar}} | {{Template:Op menubar}} | ||
{{Template: | {{Template:GOCDB_menubar}} | ||
{{TOC_right}} | {{TOC_right}} | ||
[[Category:GOCDB]] | [[Category:GOCDB]] | ||
Line 23: | Line 23: | ||
| interval || Limit results to downtimes that have been inserted in the past interval days || number || 1 || ?method=get_downtime_to_broadcast&interval=7 | | interval || Limit results to downtimes that have been inserted in the past interval days || number || 1 || ?method=get_downtime_to_broadcast&interval=7 | ||
|- | |- | ||
| scope | | scope | ||
| 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. '&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 | |||
| [https://wiki.egi.eu/wiki/GOCDB/notifications#Optional_Cursor_Paging_on_Read_API See here for info] | |||
| | |||
| | |||
|- | |||
|} | |} | ||
<!--- Removed from V5 | |||
=== XML schema === | === XML schema === | ||
https://goc.egi.eu/gocdbpi/private/?method=get_downtime_to_broadcast&output=xmlschema | https://goc.egi.eu/gocdbpi/private/?method=get_downtime_to_broadcast&output=xmlschema | ||
--> | |||
=== Output Example === | === Output Example === | ||
<Source Lang="XML"> | |||
<?xml version="1.0"?> | <?xml version="1.0"?> | ||
<results> | <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> | |||
</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 15: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>