Difference between revisions of "GOCDB/PI/get ngi"

From EGIWiki
< GOCDB‎ | PI
Jump to: navigation, search
(Created page with "== Method: get_ngi - GOCDB4 == {| |- | '''Description''' | Returns a list of service groups and the roles under those groups. |- | '''Protection Level''' | Protected (level 2...")
 
(parameters)
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Method: get_ngi - GOCDB4  ==
+
{{Template:Op menubar}}
 +
{{Template:GOCDB_menubar}}
 +
{{TOC_right}}
 +
[[Category:GOCDB]]
 +
 
 +
== Method: get_ngi ==
  
 
{|
 
{|
 
|-
 
|-
 
| '''Description'''  
 
| '''Description'''  
| Returns a list of service groups and the roles under those groups.
+
| Returns a list of NGIs with contact information
 
|-
 
|-
 
| '''Protection Level'''  
 
| '''Protection Level'''  
Line 12: Line 17:
 
=== Entry point  ===
 
=== Entry point  ===
  
*https://goc.egi.eu/gocdbpi/private/?method=get_service_group_role<br>
+
*https://goc.egi.eu/gocdbpi/private/?method=get_ngi<br>
  
 
=== parameters  ===
 
=== parameters  ===
 
+
{| {{egi-table}}
{| border="1"
 
 
|-
 
|-
 
! parameter  
 
! parameter  
Line 24: Line 28:
 
! example
 
! example
 
|-
 
|-
| service_group_name
+
| roc (ngi)
| Only return info for the service group with specified site name  
+
| Specify NGI name  
| any service group name<br>
+
| any NGI name  
 
| all  
 
| all  
| &nbsp;?method=get_service_group_role&amp;service_group_name=OPSTOOLS
+
| &nbsp;?method=get_ngi&roc=NGI_UK
 +
|-
 +
| 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. '&amp;scope='
 +
| EGI
 +
| &nbsp;?method=get_ngi&amp;scope=Local
 +
|-
 +
| scope_match
 +
| Match 'all' or 'any' of the specified scope-tags
 +
| 'all' or 'any'
 +
| all
 +
| &nbsp;?method=get_ngi&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]
 +
|
 +
|
 +
|-
 
|}
 
|}
 
<br>
 
  
 
=== Output Example  ===
 
=== Output Example  ===
 
+
<Source Lang="XML">
<span class="pi">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+
<?xml version="1.0" encoding="UTF-8"?>
&lt;results&gt;
+
<results>
  &lt;SERVICE_GROUP PRIMARY_KEY="57654G0"&gt;
+
  <NGI NAME="NGI_UK">
    &lt;NAME&gt;OPSTOOLS&lt;/NAME&gt;
+
    <PRIMARY_KEY>35</PRIMARY_KEY>
    &lt;DESCRIPTION&gt;All EGI Operational Tools&lt;/DESCRIPTION&gt;
+
    <NAME>NGI_UK</NAME>
    &lt;MONITORED&gt;Y&lt;/MONITORED&gt;
+
    <OBJECT_ID>35</OBJECT_ID>
    &lt;CONTACT_EMAIL&gt;gocdb-admins@mailtalk.ac.uk&lt;/CONTACT_EMAIL&gt;
+
    <DESCRIPTION>United Kingdon NGI</DESCRIPTION>
    &lt;GOCDB_PORTAL_URL&gt;https://gocdb4.esc.rl.ac.uk/portal/index.php?Page_Type=View_Object&amp;amp;object_id=107045&amp;amp;grid_id=0&lt;/GOCDB_PORTAL_URL&gt;
+
    <EMAIL>UKNGI-OPERATIONS@jiscmail.ac.uk</EMAIL>
    &lt;USER&gt;
+
    <GGUS_SU>NGI_UK</GGUS_SU>
      &lt;FORENAME&gt;David&lt;/FORENAME&gt;
+
    <ROD_EMAIL>uki-grid-ops@cern.ch</ROD_EMAIL>
      &lt;SURNAME&gt;Meredith&lt;/SURNAME&gt;
+
    <HELPDESK_EMAIL/>
      &lt;CERTDN&gt;/C=UK/O=eScience/OU=CLRC/L=DL/CN=david meredith&lt;/CERTDN&gt;
+
    <SECURITY_EMAIL>ukngi-security@cern.ch</SECURITY_EMAIL>
      &lt;GOCDB_PORTAL_URL&gt;https://gocdb4.esc.rl.ac.uk/portal/index.php?Page_Type=View_Object&amp;amp;object_id=22252&amp;amp;grid_id=0&lt;/GOCDB_PORTAL_URL&gt;
+
    <SITE_COUNT>58</SITE_COUNT>
      &lt;ROLE&gt;Service Group Administrator&lt;/ROLE&gt;
+
    <SCOPES>
    &lt;/USER&gt;
+
      <SCOPE>EGI</SCOPE>
    &lt;USER&gt;
+
    </SCOPES>
      &lt;FORENAME&gt;John&lt;/FORENAME&gt;
+
  </NGI>
      &lt;SURNAME&gt;Casson&lt;/SURNAME&gt;
+
</results>
      &lt;CERTDN&gt;/C=UK/O=eScience/OU=CLRC/L=RAL/CN=john casson&lt;/CERTDN&gt;
+
</Source>
      &lt;GOCDB_PORTAL_URL&gt;https://gocdb4.esc.rl.ac.uk/portal/index.php?Page_Type=View_Object&amp;amp;object_id=6200&amp;amp;grid_id=0&lt;/GOCDB_PORTAL_URL&gt;
 
      &lt;ROLE&gt;Service Group Administrator&lt;/ROLE&gt;
 
    &lt;/USER&gt;
 
  &lt;/SERVICE_GROUP&gt;
 
&lt;/results&gt;
 
</span><span>
 
</span>
 
  
 
[[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:27, 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_ngi

Description Returns a list of NGIs with contact information
Protection Level Protected (level 2)

Entry point

parameters

parameter effect format/value(s) default example
roc (ngi) Specify NGI name any NGI name all  ?method=get_ngi&roc=NGI_UK
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_ngi&scope=Local
scope_match Match 'all' or 'any' of the specified scope-tags 'all' or 'any' all  ?method=get_ngi&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" encoding="UTF-8"?>
<results>
  <NGI NAME="NGI_UK">
    <PRIMARY_KEY>35</PRIMARY_KEY>
    <NAME>NGI_UK</NAME>
    <OBJECT_ID>35</OBJECT_ID>
    <DESCRIPTION>United Kingdon NGI</DESCRIPTION>
    <EMAIL>UKNGI-OPERATIONS@jiscmail.ac.uk</EMAIL>
    <GGUS_SU>NGI_UK</GGUS_SU>
    <ROD_EMAIL>uki-grid-ops@cern.ch</ROD_EMAIL>
    <HELPDESK_EMAIL/>
    <SECURITY_EMAIL>ukngi-security@cern.ch</SECURITY_EMAIL>
    <SITE_COUNT>58</SITE_COUNT>
    <SCOPES>
      <SCOPE>EGI</SCOPE>
    </SCOPES>
  </NGI>
</results>

Back to GOCDB technical Documentation main page