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

From EGIWiki
< GOCDB‎ | PI
Jump to navigation Jump to search
m
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:Op menubar}}
{{Template:GOCDB_menubar}}
{{TOC_right}}
[[Category:GOCDB]]
== Method: get_site_list ==
== Method: get_site_list ==


Line 10: Line 14:
=== Entry point ===
=== Entry point ===


* https://goc.gridops.org/gocdbpi/public/?method=get_site_list
https://goc.egi.eu/gocdbpi/public/?method=get_site_list
* https://goc.gridops.org/gocdbpi_v4/public/?method=get_site_list (alias)


=== parameters ===
=== parameters ===
Line 20: Line 23:
| sitename || Only return infos for site with specified site name || any sitename || all || ?method=get_site_list&sitename=RAL-LCG2  
| sitename || Only return infos for site with specified site name || any sitename || all || ?method=get_site_list&sitename=RAL-LCG2  
|-
|-
| roc (ngi) || Limit results to sites belonging to given NGI || any ngi name || all || ?method=get_site_list&roc=NGI_DE  
| roc (ngi) || Limit results to sites belonging to given NGI || any NGI name || all || ?method=get_site_list&roc=NGI_DE  
|-
|-
| country || Limit results to sites belonging to given country || any country || all || ?method=get_site_list&country=Poland
| country || Limit results to sites belonging to given country || any country || all || ?method=get_site_list&country=Poland
Line 26: Line 29:
| certification_status || Limit results to sites with given certification status || one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" || all || ?method=get_site_list&certification_status=Certified  
| certification_status || Limit results to sites with given certification status || one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" || all || ?method=get_site_list&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_list&exclude_certification_status=Closed
|-
| production_status || Limit results to sites within given production infrastructure || one of "Production" or "Test" <strike>"PPS" "SC"(deprecated)</strike>  || all || ?method=get_site_list&production_status=Production
|-
| 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_site&amp;scope=Local
|-
| scope_match
| Match 'all' or 'any' of the specified scope-tags
| 'all' or 'any'
| all
| &nbsp;?method=get_site_list&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_list&amp;extensions=(KeyName=KeyValue)
|-
|}
|}
<!--- Removed from V5=== XML schema ===
https://goc.egi.eu/gocdbpi_v4/public/?method=get_site_list&output=xmlschema
-->
=== Output Example ===
<Source Lang="XML">
<?xml version="1.0"?>
<results>
  <SITE ID="414" PRIMARY_KEY="320G0" NAME="Australia-ATLAS" COUNTRY="Australia" COUNTRY_CODE="AU" ROC="AsiaPacific" SUBGRID=" " GIIS_URL="ldap://agh6.atlas.unimelb.edu.au:2170/mds-vo-name=Australia-ATLAS,o=grid"/>
  <SITE ID=" " PRIMARY_KEY="445G0" NAME="giDCUie" COUNTRY="Ireland" COUNTRY_CODE="IE" ROC="UKI" SUBGRID="GridIreland" GIIS_URL="ldap://gridgate.dcu.ie:2170/Mds-Vo-name=giDCUie,o=Grid"/>
</results>
</Source>
[[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]]

Latest revision as of 10:11, 19 September 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_site_list

Description Returns a list of sites with minimal associated information
Protection Level Public (level 1)

Entry point

https://goc.egi.eu/gocdbpi/public/?method=get_site_list

parameters

parameter effect format/value(s) default example
sitename Only return infos for site with specified site name any sitename all ?method=get_site_list&sitename=RAL-LCG2
roc (ngi) Limit results to sites belonging to given NGI any NGI name all ?method=get_site_list&roc=NGI_DE
country Limit results to sites belonging to given country any country all ?method=get_site_list&country=Poland
certification_status Limit results to sites with given certification status one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" all ?method=get_site_list&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_list&exclude_certification_status=Closed
production_status Limit results to sites within given production infrastructure one of "Production" or "Test" "PPS" "SC"(deprecated) all  ?method=get_site_list&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_list&scope=Local,EGI&scope_match=any
extensions Limit results by one or many key value pairs See Extensions Mechanism none  ?method=get_site_list&extensions=(KeyName=KeyValue)


Output Example

<?xml version="1.0"?>
 <results>
  <SITE ID="414" PRIMARY_KEY="320G0" NAME="Australia-ATLAS" COUNTRY="Australia" COUNTRY_CODE="AU" ROC="AsiaPacific" SUBGRID=" " GIIS_URL="ldap://agh6.atlas.unimelb.edu.au:2170/mds-vo-name=Australia-ATLAS,o=grid"/>
  <SITE ID=" " PRIMARY_KEY="445G0" NAME="giDCUie" COUNTRY="Ireland" COUNTRY_CODE="IE" ROC="UKI" SUBGRID="GridIreland" GIIS_URL="ldap://gridgate.dcu.ie:2170/Mds-Vo-name=giDCUie,o=Grid"/>
 </results>

Back to GOCDB technical Documentation main page