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/Technical Documentation"

From EGIWiki
< GOCDB‎ | PI
Jump to navigation Jump to search
m
(Deprecate and redirect page)
Tag: Replaced
 
(98 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== GOCDB Programmatic Interface ==
{{Template:Op menubar}}
=== Important information about using the GOCDBPI ===
{{Template:GOCDB_menubar}}
==== Releases, changes and announcements ====
{{TOC_top}}
 
[[Category:GOCDB]]
All client tool using GOCDB should register someone to the GOCDB discussion mailing list: gocdb-discuss_at_mailtalk.ac.uk. Releases, new features, changes in methods and general announcements related to this interface are made on this list.
{{DeprecatedAndMovedTo|new_location=https://gocdb.github.io/api/}}
 
If your application is using the GOCDB Programmatic interface please request to join this mailing list by sending us a mail to [mailto:gocdb-admins@mailtalk.ac.uk gocdb-admins@mailtalk.ac.uk].
 
<!-- OBSOLETE ==== Recent changes ====
Some changes have been made to the GOCDB-PI to follow GOCDB-4 model changes. You can browse the change summary page and the list of compatibility tests to know more about this, especially if you were used to the old system. -->
 
=== Interface description ===
==== Interface type ====
GOCDB Programmatic Interface is a [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] (Representational State Transfer) based interface over https. The use of https guarantees URLs are properly secured when transiting. Some of the methods are nonetheless public and don't require client side authentication (see [[#Data protection and access]]).
 
==== Entry point ====
Enter GOCDB here https://goc.gridops.org/ or directly at https://goc.gridops.org/portal/ to browse the global EGI information or at https://gocdb4.esc.rl.ac.uk/portal to update information.
 
Entry point for every single method is given on method definition pages listed below.
 
==== Outputs ====
Output format is '''XML'''. Calling any implemented method will return you a valid DOM document that can be parsed by any tool on client side.
 
==== Schemas ====
The associated '''XML schema''' for each method is available by calling the method with "&output=xmlschema", e.g. https://goc.gridops.org/gocdbpi/private/?method=get_site&output=xmlschema
 
 
 
=== Data protection and access ===
 
==== Protection levels ====
There are currently 3 protection levels for all methods of the interface
 
* '''Level 1''': public methods (no critical information, no mail, no personal details)
* '''Level 2''': protected methods (contain mails or personal details)
* '''Level 3''': private methods (contains security or critical information)
 
Methods at level 1 are available without restrictions. Level 2 requires client to present a valid recognized X509 certificate (reference CA list is the officially agreed EGEE/LCG EUGridPMA list). Level 3 requires client to present a known, registered certificate (certificate DN needs to be stored on GOCDB side for authentication)
 
 
==== How to gain access? ====
If you need to access protected methods, a valid certificate will be enough. If you need to access private methods, please send a mail to [mailto:gocdb-admins@mailtalk.ac.uk gocdb-admins@mailtalk.ac.uk], indicating:
 
* Your name and affiliation
* The name and purpose of the tool that need to access the data
* certificate DN of the machine(s) that will retrieve the information
* An e-mail contact for your application, that will be subscribed to the GOCDB-discussion and announcement mailing list if it is not already there.
 
 
 
=== Available methods ===
{| {{egi-table}}  
! Method name !! type !! description !! Protection level
|-
|[[GOCDB_PI_get_site_method|get_site]] || read - generic || Returns site information including contacts, grouped by site || 2
|-
|[[GOCDB_PI_get_site_list_method|get_site_list]] || read - generic || Returns a list of sites with minimal associated information || 1
|-
|[[GOCDB_PI_get_site_contacts_method|get_site_contacts]] || read - generic || Returns a list of persons (and associated info) having a role at site level, grouped per site ||2
|-
|[[GOCDB_PI_get_site_security_info_method|get_site_security_info]] || read - generic || Returns security contact information for sites || 3
|-
|[[GOCDB_PI_get_ngi_list_method|get_ngi_list]] || read - generic || Returns a list of NGIs with minimal associated information || 1
|-
|[[GOCDB_PI_get_subgrid_list_method|get_subgrid_list]] || read - generic || Returns a list of Subgrids (i.e. registered sub-parts of an NGI) with minimal associated information || 1
|-
|[[GOCDB_PI_get_ngi_contacts_method|get_ngi_contacts]] || read - generic || Returns NGI contact details, including NGI contact mail address and list of NGI staff || 2
|-
|[[GOCDB_PI_get_egi_contacts_method|get_egi_contacts]] || read - generic || Returns a list of contacts for staff that have a role a EGI level || 2
|-
|[[GOCDB_PI_get_downtime_method|get_downtime]] || read - generic || Returns a list of EGI downtimes for sites and nodes || 1
|-
|[[GOCDB_PI_get_node_method|get_node]] [unsupported] || read - generic || Returns a list of nodes with associated information and affiliation || 1
|-
|[[GOCDB_PI_get_service_endpoint_method|get_service_endpoint]] || read - generic || Returns a list of service endpoints (single node x single service) and associated information || 1
|-
|[[GOCDB_PI_get_service_types_method|get_service_types]] || read - generic || Returns a list of valid service types and associated description || 1
|-
|[[GOCDB_PI_get_user_method|get_user]] || read - generic || Returns a user or a list of users with associated details and roles || 2
|-
|[[GOCDB_PI_get_downtime_to_broadcast_method|get_downtime_to_broadcast]] || read - dedicated || Returns the list of downtimes recently declared with notification settings for CIC portal downtime notification service || 2
|}
 
'''Note about parameters:'''
 
* Unless otherwise stated, all parameters are optional. If no parameter is given, all methods will return results with the wider scope possible.
* It is possible to combine parameters, for example: ''?method=get_site&country=Italy&certification_status=Certified&production_status=Production''
 
 
=== Client code examples ===
==== Simple data retrieval using wget ====
If getting the data locally is what you're after, a simple cron job retrieving data via wget might do the trick.
 
* Public methods: You do not need any client certificate, so a simple wget instruction should work:
 
$ wget --no-check-certificate -O result.xml 'https://goc.gridops.org/gocdbpi/public/?method=get_site_list&sitename=RAL-LCG2'
 
''--no-check-certificate'' option might be needed to avoid server verification. Note also that URL should be encapsulated into single quotes.
 
* Protected and private methods: Here you will need authentication, which can be done through wget as shown in next example:
 
$ wget --certificate=cert.pem --private-key=cert.key.pem --private-key-type=PEM --ca-directory=/etc/grid-security/certificates/ -O result.xml 'https://goc.gridops.org/gocdbpi/private/?method=get_site&sitename=RAL-LCG2'

Latest revision as of 18:45, 15 November 2022

Main EGI.eu operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security


GOC DB menu: Home • Documentation Index •


Alert.png This article is Deprecated and has been moved to https://gocdb.github.io/api/.


Retrieved from "https://wiki.egi.eu/w/index.php?title=GOCDB/PI/Technical_Documentation&oldid=113883"