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 site method"

From EGIWiki
< GOCDB‎ | PI
Jump to navigation Jump to search
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Op menubar}}
{{Template:Op menubar}}
{{Template:Tools menubar}}
{{Template:GOCDB_menubar}}
{{TOC_right}}
{{TOC_right}}
[[Category:GOCDB]]
[[Category:GOCDB]]
Line 14: Line 14:
=== Entry point ===
=== Entry point ===


* https://goc.egi.eu/gocdbpi/private/?method=get_site  
* https://goc.egi.eu/gocdbpi/public/?method=get_site  
* https://goc.egi.eu/gocdbpi_v4/private/?method=get_site (alias)
* https://goc.egi.eu/gocdbpi_v4/private/?method=get_site (alias)


=== parameters  ===
=== parameters  ===


{|
{| {{egi-table}}
|-
|-
! parameter  
! parameter  
Line 59: Line 59:
| production_status  
| production_status  
| Limit results to sites within given production infrastructure  
| Limit results to sites within given production infrastructure  
| one of "Production", "PPS", "Test"  
| one of "Production", "Test" <strike>"PPS","SC"</strike>
| all  
| all  
| &nbsp;?method=get_site&amp;production_status=PPS
| &nbsp;?method=get_site&amp;production_status=Production
|-
|-
| scope  
| scope  
| Show only sites in the passed scope (Local and EGI are currenlty 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]
| "Local" or "EGI"
| A comma separated list of scope-tag values or an empty value to return all scopes, i.e. '&amp;scope='
| EGI
| EGI
| &nbsp;?method=get_site&amp;scope=Local
| &nbsp;?method=get_site&amp;scope=Local
|-
| scope_match
| Match 'all' or 'any' of the specified scope-tags
| 'all' or 'any'
| all
| &nbsp;?method=get_site&amp;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
| &nbsp;?method=get_site&amp;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/private/?method=get_site&output=xmlschema
https://goc.egi.eu/gocdbpi/private/?method=get_site&output=xmlschema
-->


=== Output Example ===
=== Output Example ===
 
<Source lang="XML">
<?xml version="1.0"?>
<?xml version="1.0" encoding="UTF-8"?>
<results>
<results>
   <SITE ID="1" PRIMARY_KEY="194G0" NAME="RAL-LCG2">
   <SITE ID="335" PRIMARY_KEY="123G0" NAME="GRIDOPS-GOCDB">
  <PRIMARY_KEY>194G0</PRIMARY_KEY>
    <PRIMARY_KEY>123G0</PRIMARY_KEY>
  <SHORT_NAME>RAL-LCG2</SHORT_NAME>
    <SHORT_NAME>GRIDOPS-GOCDB</SHORT_NAME>
  <GOCDB_PORTAL_URL>
    <OFFICIAL_NAME>Grid Operations Center Database Portal and Web Services</OFFICIAL_NAME>
     <nowiki>https://next.gocdb.eu/portal/index.php?Page_Type=View_Object&object_id=1133&grid_id=0</nowiki>
    <SITE_DESCRIPTION>The GOCDB (v 5.5) stores Grid topology and resource information for EGI including sites, services, downtimes and contact information.</SITE_DESCRIPTION>
  </GOCDB_PORTAL_URL>
     <GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Site&amp;id=335</GOCDB_PORTAL_URL>
  <OFFICIAL_NAME>RAL, GridPP Tier-1 Computing, Oxfordshire UK</OFFICIAL_NAME>
    <HOME_URL>https://goc.egi.eu</HOME_URL>
  <SITE_DESCRIPTION>Rutherford Appleton Laboratory - Tier1</SITE_DESCRIPTION>
    <CONTACT_EMAIL>gocdb-admins@mailman.egi.eu</CONTACT_EMAIL>
  <HOME_URL><nowiki>http://mywebsite.com</nowiki></HOME_URL>
    <CONTACT_TEL>+44 01925 603762, +44 01235 44 5010</CONTACT_TEL>
  <CONTACT_EMAIL>contact@demo.com</CONTACT_EMAIL>
    <COUNTRY_CODE>GB</COUNTRY_CODE>
  <CONTACT_TEL>+44 (0) 1235 446777 </CONTACT_TEL>
    <COUNTRY>United Kingdom</COUNTRY>
  <ALARM_EMAIL>alarm@demo.com</ALARM_EMAIL>
    <ROC>EGI.eu</ROC>
  <GIIS_URL> ldap://site-bdii.gridpp.rl.ac.uk:2170/mds-vo-name=RAL-LCG2,o=grid
    <PRODUCTION_INFRASTRUCTURE>Production</PRODUCTION_INFRASTRUCTURE>
  </GIIS_URL>
    <CERTIFICATION_STATUS>Certified</CERTIFICATION_STATUS>
  <TIER>2</TIER>
    <TIMEZONE>Europe/London</TIMEZONE>
  <COUNTRY_CODE>GB</COUNTRY_CODE>
    <CSIRT_EMAIL>gocdb-admins@mailman.egi.eu</CSIRT_EMAIL>
  <COUNTRY>United Kingdom</COUNTRY>
    <NOTIFICATIONS>FALSE</NOTIFICATIONS>
  <ROC>UKI</ROC>
    <DOMAIN>
  <SUBGRID>Tier1A</SUBGRID>
      <DOMAIN_NAME>goc.egi.eu</DOMAIN_NAME>
  <PRODUCTION_INFRASTRUCTURE>Production</PRODUCTION_INFRASTRUCTURE>
    </DOMAIN>
  <CERTIFICATION_STATUS>Certified</CERTIFICATION_STATUS>
    <SITE_IP>0.0.0.0/255.255.255.254</SITE_IP>
  <TIMEZONE>Europe/London</TIMEZONE>
    <SCOPES>
  <LATITUDE>51</LATITUDE>
      <SCOPE>EGI</SCOPE>
  <LONGITUDE>-1</LONGITUDE>
    </SCOPES>
  <DOMAIN>
    <EXTENSIONS>
     <DOMAIN_NAME>gridpp.rl.ac.uk</DOMAIN_NAME>
      <EXTENSION>
  </DOMAIN>
        <LOCAL_ID>371</LOCAL_ID>
        <KEY>P4U_Pilot_Storage_Use_Cloud</KEY>
        <VALUE>1</VALUE>
      </EXTENSION>
     </EXTENSIONS>
   </SITE>
   </SITE>
</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 15:32, 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_site - GOCDB4

Description Returns site information including contacts, grouped by site
Protection Level Protected (level 2)

Entry point

parameters

parameter effect format/value(s) default example
sitename Only return infos for site with specified site name any sitename all  ?method=get_site&sitename=RAL-LCG2
roc (ngi) Limit results to sites belonging to given NGI any NGI name all  ?method=get_site&roc=NGI_DE
country Limit results to sites belonging to given country any country all  ?method=get_site&country=Poland
certification_status Limit results to sites with given certification status one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" all  ?method=get_site&certification_status=Certified
exclude_certification_status Exclude from results sites with given certification status one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" none  ?method=get_site&exclude_certification_status=Closed
production_status Limit results to sites within given production infrastructure one of "Production", "Test" "PPS","SC" all  ?method=get_site&production_status=Production
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_site&scope=Local
scope_match Match 'all' or 'any' of the specified scope-tags 'all' or 'any' all  ?method=get_site&scope=Local,EGI&scope_match=any
extensions Limit results by one or many key value pairs See Extensions Mechanism none  ?method=get_site&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>
  <SITE ID="335" PRIMARY_KEY="123G0" NAME="GRIDOPS-GOCDB">
    <PRIMARY_KEY>123G0</PRIMARY_KEY>
    <SHORT_NAME>GRIDOPS-GOCDB</SHORT_NAME>
    <OFFICIAL_NAME>Grid Operations Center Database Portal and Web Services</OFFICIAL_NAME>
    <SITE_DESCRIPTION>The GOCDB (v 5.5) stores Grid topology and resource information for EGI including sites, services, downtimes and contact information.</SITE_DESCRIPTION>
    <GOCDB_PORTAL_URL>https://goc.egi.eu/portal/index.php?Page_Type=Site&amp;id=335</GOCDB_PORTAL_URL>
    <HOME_URL>https://goc.egi.eu</HOME_URL>
    <CONTACT_EMAIL>gocdb-admins@mailman.egi.eu</CONTACT_EMAIL>
    <CONTACT_TEL>+44 01925 603762, +44 01235 44 5010</CONTACT_TEL>
    <COUNTRY_CODE>GB</COUNTRY_CODE>
    <COUNTRY>United Kingdom</COUNTRY>
    <ROC>EGI.eu</ROC>
    <PRODUCTION_INFRASTRUCTURE>Production</PRODUCTION_INFRASTRUCTURE>
    <CERTIFICATION_STATUS>Certified</CERTIFICATION_STATUS>
    <TIMEZONE>Europe/London</TIMEZONE>
    <CSIRT_EMAIL>gocdb-admins@mailman.egi.eu</CSIRT_EMAIL>
    <NOTIFICATIONS>FALSE</NOTIFICATIONS>
    <DOMAIN>
      <DOMAIN_NAME>goc.egi.eu</DOMAIN_NAME>
    </DOMAIN>
    <SITE_IP>0.0.0.0/255.255.255.254</SITE_IP>
    <SCOPES>
      <SCOPE>EGI</SCOPE>
    </SCOPES>
    <EXTENSIONS>
      <EXTENSION>
        <LOCAL_ID>371</LOCAL_ID>
        <KEY>P4U_Pilot_Storage_Use_Cloud</KEY>
        <VALUE>1</VALUE>
      </EXTENSION>
    </EXTENSIONS>
  </SITE>
</results>

Back to GOCDB technical Documentation main page