Difference between revisions of "GOCDB/PI/get site count per country"

From EGIWiki
< GOCDB‎ | PI
Jump to: navigation, search
(Created page with "Doc comming soon")
 
(parameters)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Doc comming soon
+
{{Template:Op menubar}}
 +
{{Template:GOCDB_menubar}}
 +
{{TOC_right}}
 +
[[Category:GOCDB]]
 +
== Method: get_site_count_per_country ==
 +
 
 +
{| {{egi-table}}
 +
|-
 +
| '''Description''' || Returns a list of countries with site count
 +
|-
 +
| '''Protection Level''' || Public (level 1)
 +
|}
 +
 
 +
=== Entry point ===
 +
Count all sites regardless of scope/status: <br/>
 +
https://goc.egi.eu/gocdbpi/public/?method=get_site_count_per_country
 +
<br/>
 +
Count only EGI scoped, production and certified sites:<br/>
 +
https://goc.egi.eu/gocdbpi/public/?method=get_site_count_per_country&scope=EGI&certification_status=Certified&production_status=Production
 +
 
 +
=== parameters ===
 +
 
 +
{| {{egi-table}}
 +
! parameter !! effect !! format/value(s) !! default !! example
 +
|-
 +
| certification_status || Limit site count to sites with given certification status || one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" || all|| ?method=get_site_list&certification_status=Certified
 +
|-
 +
| production_status || Limit site count to a given production infrastructure || one of "Production" or "Test" <strike>"PPS" "SC"(deprecated)</strike>  || all|| ?method=get_site_list&production_status=Production
 +
|-
 +
| scope
 +
| Count only sites with the requested scope-tag (only a single scope value is supported rather than a comma-separated list, and scope_match is not supported). A list of currently supported scope tags can be found [https://goc.egi.eu/portal/index.php?Page_Type=Scope_Help here].
 +
| A single scope parameter is supported by this query
 +
| all
 +
| &nbsp;?method=get_site_count_per_country&amp;scope=EGI
 +
|-
 +
|}
 +
 
 +
=== Output Example ===
 +
<Source Lang="XML">
 +
<?xml version="1.0"?>
 +
<results>
 +
  <SITE><COUNTRY>Afghanistan</COUNTRY><COUNT>0</COUNT></SITE>
 +
  <SITE><COUNTRY>Albania</COUNTRY><COUNT>0</COUNT></SITE>
 +
  <SITE><COUNTRY>Algeria</COUNTRY><COUNT>1</COUNT></SITE>
 +
</results>
 +
</Source>
 +
[[GOCDB/PI/Technical_Documentation|Back to GOCDB technical Documentation main page]]

Latest revision as of 10:29, 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_count_per_country

Description Returns a list of countries with site count
Protection Level Public (level 1)

Entry point

Count all sites regardless of scope/status:
https://goc.egi.eu/gocdbpi/public/?method=get_site_count_per_country
Count only EGI scoped, production and certified sites:
https://goc.egi.eu/gocdbpi/public/?method=get_site_count_per_country&scope=EGI&certification_status=Certified&production_status=Production

parameters

parameter effect format/value(s) default example
certification_status Limit site count to sites with given certification status one of "Candidate", "Uncertified", "Certified", "Closed", Suspended" all ?method=get_site_list&certification_status=Certified
production_status Limit site count to a given production infrastructure one of "Production" or "Test" "PPS" "SC"(deprecated) all ?method=get_site_list&production_status=Production
scope Count only sites with the requested scope-tag (only a single scope value is supported rather than a comma-separated list, and scope_match is not supported). A list of currently supported scope tags can be found here. A single scope parameter is supported by this query all  ?method=get_site_count_per_country&scope=EGI

Output Example

<?xml version="1.0"?>
 <results>
  <SITE><COUNTRY>Afghanistan</COUNTRY><COUNT>0</COUNT></SITE>
  <SITE><COUNTRY>Albania</COUNTRY><COUNT>0</COUNT></SITE>
  <SITE><COUNTRY>Algeria</COUNTRY><COUNT>1</COUNT></SITE>
 </results>

Back to GOCDB technical Documentation main page