Difference between revisions of "GOCDB/PI/get service endpoint method"
Jump to navigation
Jump to search
(23 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}} | ||
== Method: get_service_endpoint == | [[Category:GOCDB]] | ||
== Method: get_service_endpoint or get_service == | |||
{| {{egi-table}} | {| {{egi-table}} | ||
Line 12: | Line 13: | ||
=== Entry point === | === Entry point === | ||
https://goc.egi.eu/gocdbpi/public/?method=get_service_endpoint | https://goc.egi.eu/gocdbpi/public/?method=get_service_endpoint | ||
<br> | |||
or (both are equivalent) | |||
<br> | |||
https://goc.egi.eu/gocdbpi/public/?method=get_service | |||
=== parameters === | === parameters === | ||
Line 32: | Line 38: | ||
| monitored || Limit results to services hosted on nodes that have monitoring turned on || Y or N || all || ?method=get_service_endpoint&monitored=Y | | monitored || Limit results to services hosted on nodes that have monitoring turned on || Y or N || all || ?method=get_service_endpoint&monitored=Y | ||
|- | |- | ||
| 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_service_endpoint&scope=Local | |||
|- | |||
| scope_match | |||
| Match 'all' or 'any' of the specified scope-tags | |||
| 'all' or 'any' | |||
| all | |||
| ?method=get_service_endpoint&scope=Local,EGI&scope_match=any | |||
|- | |||
| extensions | |||
| Limit results by one or many key value pairs | |||
| [https://wiki.egi.eu/wiki/GOCDB/Input_System_User_Documentation#Extension_Properties See Extensions Mechanism] | |||
| none | |||
| ?method=get_service_endpoint&extensions=(KeyName=KeyValue) | |||
|- | |||
| 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/public/?method=get_service_endpoint&output=xmlschema | https://goc.egi.eu/gocdbpi/public/?method=get_service_endpoint&output=xmlschema | ||
--> | |||
=== Output Example === | === Output Example === | ||
< | <Source lang="XML"> | ||
<?xml version="1.0" encoding="UTF-8"?> | |||
<results> | |||
<SERVICE_ENDPOINT PRIMARY_KEY=" | <SERVICE_ENDPOINT PRIMARY_KEY="4180G0"> | ||
<PRIMARY_KEY>4180G0</PRIMARY_KEY> | |||
<HOSTNAME>goc.egi.eu</HOSTNAME> | |||
<GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Service&id=4180</GOCDB_PORTAL_URL> | |||
<HOSTDN>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=goc.egi.eu</HOSTDN> | |||
<HOST_ARCH>x86_64</HOST_ARCH> | |||
<BETA>N</BETA> | |||
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE> | |||
<CORE></CORE> | |||
<IN_PRODUCTION>Y</IN_PRODUCTION> | |||
<NODE_MONITORED>Y</NODE_MONITORED> | |||
<NOTIFICATIONS>Y</NOTIFICATIONS> | |||
<SITENAME>GRIDOPS-GOCDB</SITENAME> | |||
<COUNTRY_NAME>United Kingdom</COUNTRY_NAME> | |||
<COUNTRY_CODE>GB</COUNTRY_CODE> | |||
<ROC_NAME>EGI.eu</ROC_NAME> | |||
<URL>https://goc.egi.eu:443</URL> | |||
<ENDPOINTS> | |||
<ENDPOINT> | |||
<ID>6313</ID> | |||
<NAME>ProductionPortalInstance</NAME> | |||
<EXTENSIONS/> | |||
<URL>https://goc.egi.eu/portal</URL> | |||
<INTERFACENAME>egi.GOCDB.Portal</INTERFACENAME> | |||
</ENDPOINT> | |||
<ENDPOINT> | |||
<ID>6314</ID> | |||
<NAME>Production PI base url</NAME> | |||
<EXTENSIONS/> | |||
<URL>https://goc.egi.eu/gocdbpi</URL> | |||
<INTERFACENAME>egi.GOCDB.PI</INTERFACENAME> | |||
</ENDPOINT> | |||
<ENDPOINT> | |||
<ID>6355</ID> | |||
<NAME>Failover PI</NAME> | |||
<EXTENSIONS/> | |||
<URL>https://goc.dl.ac.uk/gocdbpi</URL> | |||
<INTERFACENAME>egi.GOCDB.PI</INTERFACENAME> | |||
</ENDPOINT> | |||
<ENDPOINT> | |||
<ID>6356</ID> | |||
<NAME>Failover portal</NAME> | |||
<EXTENSIONS/> | |||
<URL>https://goc.dl.ac.uk/portal</URL> | |||
<INTERFACENAME>egi.GOCDB.Portal</INTERFACENAME> | |||
</ENDPOINT> | |||
</ENDPOINTS> | |||
<SCOPES> | |||
<SCOPE>EGI</SCOPE> | |||
</SCOPES> | |||
<EXTENSIONS> | |||
<EXTENSION> | |||
<LOCAL_ID>1</LOCAL_ID> | |||
<KEY>TEST_CHARGE</KEY> | |||
<VALUE>10</VALUE> | |||
</EXTENSION> | |||
</EXTENSIONS> | |||
</SERVICE_ENDPOINT> | </SERVICE_ENDPOINT> | ||
</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 16:41, 27 October 2017
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_service_endpoint or get_service
Description | Returns a list of service endpoints (single node x single service) and associated information |
Protection Level | Public (level 1) |
Entry point
https://goc.egi.eu/gocdbpi/public/?method=get_service_endpoint
or (both are equivalent)
https://goc.egi.eu/gocdbpi/public/?method=get_service
parameters
parameter | effect | format/value(s) | default | example |
---|---|---|---|---|
hostname | Limit results to services hosted on node with given hostname | any host name | all | ?method=get_service_endpoint&hostname=dcache-tape.gridpp.rl.ac.uk |
sitename | Limit results to services provided at site with given sitename | any site name | all | ?method=get_service_endpoint&sitename=IN2P3-CC |
roc (ngi) | Limit results to services provided by given NGI | any NGI name | all | ?method=get_service_endpoint&roc=AsiaPacific |
country | Limit results to services provided by given country | any country name | all | ?method=get_service_endpoint&country=Australia |
service_type | Limit results to services of given type | any valid service type | all | ?method=get_service_endpoint&service_type=CE |
monitored | Limit results to services hosted on nodes that have monitoring turned on | Y or N | all | ?method=get_service_endpoint&monitored=Y |
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_service_endpoint&scope=Local |
scope_match | Match 'all' or 'any' of the specified scope-tags | 'all' or 'any' | all | ?method=get_service_endpoint&scope=Local,EGI&scope_match=any |
extensions | Limit results by one or many key value pairs | See Extensions Mechanism | none | ?method=get_service_endpoint&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" encoding="UTF-8"?>
<results>
<SERVICE_ENDPOINT PRIMARY_KEY="4180G0">
<PRIMARY_KEY>4180G0</PRIMARY_KEY>
<HOSTNAME>goc.egi.eu</HOSTNAME>
<GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Service&id=4180</GOCDB_PORTAL_URL>
<HOSTDN>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=goc.egi.eu</HOSTDN>
<HOST_ARCH>x86_64</HOST_ARCH>
<BETA>N</BETA>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<CORE></CORE>
<IN_PRODUCTION>Y</IN_PRODUCTION>
<NODE_MONITORED>Y</NODE_MONITORED>
<NOTIFICATIONS>Y</NOTIFICATIONS>
<SITENAME>GRIDOPS-GOCDB</SITENAME>
<COUNTRY_NAME>United Kingdom</COUNTRY_NAME>
<COUNTRY_CODE>GB</COUNTRY_CODE>
<ROC_NAME>EGI.eu</ROC_NAME>
<URL>https://goc.egi.eu:443</URL>
<ENDPOINTS>
<ENDPOINT>
<ID>6313</ID>
<NAME>ProductionPortalInstance</NAME>
<EXTENSIONS/>
<URL>https://goc.egi.eu/portal</URL>
<INTERFACENAME>egi.GOCDB.Portal</INTERFACENAME>
</ENDPOINT>
<ENDPOINT>
<ID>6314</ID>
<NAME>Production PI base url</NAME>
<EXTENSIONS/>
<URL>https://goc.egi.eu/gocdbpi</URL>
<INTERFACENAME>egi.GOCDB.PI</INTERFACENAME>
</ENDPOINT>
<ENDPOINT>
<ID>6355</ID>
<NAME>Failover PI</NAME>
<EXTENSIONS/>
<URL>https://goc.dl.ac.uk/gocdbpi</URL>
<INTERFACENAME>egi.GOCDB.PI</INTERFACENAME>
</ENDPOINT>
<ENDPOINT>
<ID>6356</ID>
<NAME>Failover portal</NAME>
<EXTENSIONS/>
<URL>https://goc.dl.ac.uk/portal</URL>
<INTERFACENAME>egi.GOCDB.Portal</INTERFACENAME>
</ENDPOINT>
</ENDPOINTS>
<SCOPES>
<SCOPE>EGI</SCOPE>
</SCOPES>
<EXTENSIONS>
<EXTENSION>
<LOCAL_ID>1</LOCAL_ID>
<KEY>TEST_CHARGE</KEY>
<VALUE>10</VALUE>
</EXTENSION>
</EXTENSIONS>
</SERVICE_ENDPOINT>
</results>