Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/read/get_cert_status_changes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `site` | Only return info for site with specified site name | any site name | `all` | `?method=get_cert_status_changes&site=RAL-LCG2` |
| `site` | Only return info for site with specified site name | any site name | `all` | `?method=get_cert_status_changes&site=Izola MRF` |
| `startdate` | Limit results to changes that start after specified date | date in `YYYY-MM-DD` format | none | `?method=get_cert_status_changes&startdate=2022-03-15` |
| `enddate` | limit results to changes that end before specified date | date in `YYYY-MM-DD` format | none | `?method=get_cert_status_changes&enddate=2022-03-25` |

Expand All @@ -31,10 +31,10 @@ This method optionally supports paging, to iterate over all results,
<result ID="1">
<TIME>13-Sep-2022 09.21.26</TIME>
<UNIX_TIME>1663060886</UNIX_TIME>
<SITE>GRIDOPS-GOCDB</SITE>
<SITE>Izola MRF</SITE>
<OLD_STATUS>Uncertified</OLD_STATUS>
<NEW_STATUS>Certified</NEW_STATUS>
<CHANGED_BY>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=example user</CHANGED_BY>
<CHANGED_BY>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=Gwei Jai</CHANGED_BY>
<COMMENT>Site is ready</COMMENT>
</result>
</results>
Expand Down
9 changes: 4 additions & 5 deletions api/read/get_cert_status_date/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `certification_status` | Limit results to sites with given certification status | one of `Candidate`, `Uncertified`, `Certified`, `Closed`, `Suspended` | `all` | `?method=get_site&certification_status=Certified` |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_DE` |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_SI` |

### Paging

Expand All @@ -27,10 +27,9 @@ This method optionally supports paging, to iterate over all results,
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<site ID="40">
<name>GRIDOPS-GOCDB</name>
<cert_status>Closed</cert_status>
<cert_date>14-Jun-22 15.51.32 PM</cert_date>
<site ID="5">
<name>Torch</name>
<cert_status>Certified</cert_status>
</site>
</results>
```
14 changes: 7 additions & 7 deletions api/read/get_downtime/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ This method optionally supports paging, to iterate over all results,
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<DOWNTIME ID="32578" PRIMARY_KEY="113653G0" CLASSIFICATION="SCHEDULED">
<PRIMARY_KEY>113653G0</PRIMARY_KEY>
<HOSTNAME>host.example.com</HOSTNAME>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<ENDPOINT>endpoint.example.stfc.ac.uk</ENDPOINT>
<HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=Downtime&id=32578</GOCDB_PORTAL_URL>
<DOWNTIME ID="32578" PRIMARY_KEY="119G0" CLASSIFICATION="SCHEDULED">
<PRIMARY_KEY>119G0</PRIMARY_KEY>
<HOSTNAME>izolamrf.co.si</HOSTNAME>
<SERVICE_TYPE>Site-BDII</SERVICE_TYPE>
<ENDPOINT>bdii4.izolamrf.si</ENDPOINT>
<HOSTED_BY>Izola MRF</HOSTED_BY>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=Downtime&amp;id=32578</GOCDB_PORTAL_URL>
<AFFECTED_ENDPOINTS/>
<SEVERITY>WARNING</SEVERITY>
<DESCRIPTION>The service will be at risk</DESCRIPTION>
Expand Down
22 changes: 11 additions & 11 deletions api/read/get_downtime_nested_services/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ This method optionally supports paging, to iterate over all results,
<END_DATE>1688169600</END_DATE>
<FORMATED_START_DATE>2022-06-27 00:00</FORMATED_START_DATE>
<FORMATED_END_DATE>2023-07-01 00:00</FORMATED_END_DATE>
<GOCDB_PORTAL_URL>/index.php?Page_Type=Downtime&id=32578</GOCDB_PORTAL_URL>
<GOCDB_PORTAL_URL>/index.php?Page_Type=Downtime&amp;id=32578</GOCDB_PORTAL_URL>
<SERVICES>
<SERVICE>
<PRIMARY_KEY>3180G0</PRIMARY_KEY>
<HOSTNAME>host.example.com</HOSTNAME>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<ENDPOINT>gocdb.host.example.com</ENDPOINT>
<HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
<PRIMARY_KEY>119G0</PRIMARY_KEY>
<HOSTNAME>bdii.ipb.ac.rs</HOSTNAME>
<SERVICE_TYPE>Top-BDII</SERVICE_TYPE>
<ENDPOINT>gocdb.bdii.ipb.ac.rs</ENDPOINT>
<HOSTED_BY>Izola MRF</HOSTED_BY>
<AFFECTED_ENDPOINTS/>
</SERVICE>
<SERVICE>
<PRIMARY_KEY>3190G0</PRIMARY_KEY>
<HOSTNAME>host2.example.com</HOSTNAME>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<ENDPOINT>gocdb2.host.example.com</ENDPOINT>
<HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
<PRIMARY_KEY>119G0</PRIMARY_KEY>
<HOSTNAME>voms.ipb.ac.rs</HOSTNAME>
<SERVICE_TYPE>VOMS</SERVICE_TYPE>
<ENDPOINT>gocdb.voms.ipb.ac.rs</ENDPOINT>
<HOSTED_BY>Izola MRF</HOSTED_BY>
<AFFECTED_ENDPOINTS/>
</SERVICE>
</SERVICES>
Expand Down
14 changes: 7 additions & 7 deletions api/read/get_downtime_to_broadcast/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ This method optionally supports paging, to iterate over all results,
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<DOWNTIME ID="32893" PRIMARY_KEY="113968G0" CLASSIFICATION="SCHEDULED">
<PRIMARY_KEY>113968G0</PRIMARY_KEY>
<SITENAME>GRIDOPS-GOCDB</SITENAME>
<HOSTNAME>example.stfc.ac.uk</HOSTNAME>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<HOSTED_BY>GRIDOPS-GOCDB</HOSTED_BY>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=Downtime&id=32893</GOCDB_PORTAL_URL>
<DOWNTIME ID="32893" PRIMARY_KEY="119G0" CLASSIFICATION="SCHEDULED">
<PRIMARY_KEY>119G0</PRIMARY_KEY>
<SITENAME>Izola MRF</SITENAME>
<HOSTNAME>izolamrf.co.si</HOSTNAME>
<SERVICE_TYPE>bdii4.izolamrf.si</SERVICE_TYPE>
<HOSTED_BY>Izola MRF</HOSTED_BY>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=Downtime&amp;id=32893</GOCDB_PORTAL_URL>
<AFFECTED_ENDPOINTS/>
<SEVERITY>WARNING</SEVERITY>
<DESCRIPTION>The service will be at risk</DESCRIPTION>
Expand Down
27 changes: 13 additions & 14 deletions api/read/get_ngi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@

| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `roc` | Limit results to sites belonging to given NGI | any NGI name | `all` | `?method=get_site&roc=NGI_DE` |
| `scope` | Show only sites with the requested scope tags | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. `&scope=` | instance dependant | `?method=get_site&scope=Local` |
| `roc` | Limit results to sites belonging to given NGI | any NGI name | `all` | `?method=get_site&roc=NGI_SI` |
| `scope` | Show only sites with the requested scope tags | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. `&scope=` | instance dependant | `?method=get_site&scope=EGI` |
| `scope_match` | Match `all` or `any` of the specified scope-tags | `all` or `any` | `all` | `?method=get_site&scope=Local,EGI&scope_match=any` |

### Paging
Expand All @@ -28,21 +28,20 @@ This method optionally supports paging, to iterate over all results,
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<NGI ID="35" NAME="NGI_UK">
<PRIMARY_KEY>35</PRIMARY_KEY>
<NAME>NGI_UK</NAME>
<OBJECT_ID>35</OBJECT_ID>
<DESCRIPTION>United Kingdom NGI</DESCRIPTION>
<EMAIL>email@example.com</EMAIL>
<GGUS_SU>NGI_UK</GGUS_SU>
<ROD_EMAIL>email@example.com</ROD_EMAIL>
<HELPDESK_EMAIL/>
<SECURITY_EMAIL>email@example.com</SECURITY_EMAIL>
<SITE_COUNT>60</SITE_COUNT>
<NGI ID="3" NAME="NGI_SI">
<PRIMARY_KEY>3</PRIMARY_KEY>
<NAME>NGI_SI</NAME>
<OBJECT_ID>3</OBJECT_ID>
<DESCRIPTION>An NGI based in Slovenia.</DESCRIPTION>
<EMAIL>ngi-si-contact@swing-grid.si</EMAIL>
<GGUS_SU/>
<ROD_EMAIL/>
<HELPDESK_EMAIL>ngi-si-helpdesk@swing-grid.si</HELPDESK_EMAIL>
<SECURITY_EMAIL>ngi-si-security@swing-grid.si</SECURITY_EMAIL>
<SITE_COUNT>4</SITE_COUNT>
<SCOPES>
<SCOPE>EGI</SCOPE>
</SCOPES>
</NGI>
</results>

```
29 changes: 19 additions & 10 deletions api/read/get_project_contacts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,18 +27,27 @@ This method optionally supports paging, to iterate over all results,
<?xml version="1.0" encoding="UTF-8"?>
<results>
<Project ID="1" NAME="EGI">
<CONTACT USER_ID="202G0" PRIMARY_KEY="202G0">
<FORENAME>Example</FORENAME>
<SURNAME>User</SURNAME>
<TITLE>Mr</TITLE>
<EMAIL>example.user@stfc.ac.uk</EMAIL>
<TEL>+00 (0) 0000 000000</TEL>
<CONTACT USER_ID="8G0" PRIMARY_KEY="8G0">
<FORENAME>Gwei</FORENAME>
<SURNAME>Jai</SURNAME>
<TITLE/>
<EMAIL>Gwei.Jai@izolamrf.si</EMAIL>
<TEL>+44 040 3636 3600</TEL>
<WORKING_HOURS_START/>
<WORKING_HOURS_END/>
<CERTDN>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=example user</CERTDN>
<EGICHECKIN/>
<IRISIAM/>
<ROLE_NAME>EGI CSIRT Officer</ROLE_NAME>
<CERTDN>/C=00/O=00000/OU=000000/CN=Gwei Jai</CERTDN>
<ROLE_NAME>COD Staff</ROLE_NAME>
</CONTACT>
<CONTACT USER_ID="9G0" PRIMARY_KEY="9G0">
<FORENAME>G</FORENAME>
<SURNAME>Wiz</SURNAME>
<TITLE/>
<EMAIL>G.Wiz@brunnengs.ch</EMAIL>
<TEL>+44 220 4244 4335</TEL>
<WORKING_HOURS_START/>
<WORKING_HOURS_END/>
<CERTDN>/C=00/O=00000/OU=000000/CN=G Wiz</CERTDN>
<ROLE_NAME>COD Staff</ROLE_NAME>
</CONTACT>
</Project>
</results>
Expand Down
40 changes: 18 additions & 22 deletions api/read/get_roc_contacts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_DE` |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_SI` |

### Paging

Expand All @@ -26,30 +26,26 @@ This method optionally supports paging, to iterate over all results,
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<ROC ID="4" ROC_NAME="EGI.eu">
<ROCNAME>EGI.eu</ROCNAME>
<MAIL_CONTACT>example@egi.eu</MAIL_CONTACT>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=NGI&id=4</GOCDB_PORTAL_URL>
<CONTACT USER_ID="406G0" PRIMARY_KEY="406G0">
<FORENAME>Example</FORENAME>
<SURNAME>User</SURNAME>
<ROC ID="3" ROC_NAME="NGI_SI">
<ROCNAME>NGI_SI</ROCNAME>
<MAIL_CONTACT>ngi-si-contact@swing-grid.si</MAIL_CONTACT>
<GOCDB_PORTAL_URL>https://localhost/portal/index.php?Page_Type=NGI&amp;id=3</GOCDB_PORTAL_URL>
<CONTACT USER_ID="8G0" PRIMARY_KEY="8G0">
<FORENAME>Gwei</FORENAME>
<SURNAME>Jai</SURNAME>
<TITLE/>
<EMAIL>example.user@stfc.ac.uk</EMAIL>
<TEL>+00 (0) 0000 000000</TEL>
<CERTDN>/C=UK/O=eScience/OU=CLRC/L=RAL/CN=example user</CERTDN>
<EGICHECKIN/>
<IRISIAM/>
<EMAIL>Gwei.Jai@izolamrf.si</EMAIL>
<TEL>+44 040 3636 3600</TEL>
<CERTDN>/C=00/O=00000/OU=000000/CN=Gwei Jai</CERTDN>
<ROLE_NAME>Regional Staff (ROD)</ROLE_NAME>
</CONTACT>
<CONTACT USER_ID="6079G0" PRIMARY_KEY="6079G0">
<FORENAME>Example</FORENAME>
<SURNAME>User</SURNAME>
<TITLE>Dr</TITLE>
<EMAIL>example.user@stfc.ac.uk</EMAIL>
<TEL/>
<CERTDN/>
<EGICHECKIN>alphanumeric@egi.eu</EGICHECKIN>
<IRISIAM/>
<CONTACT USER_ID="10G0" PRIMARY_KEY="10G0">
<FORENAME>Dante</FORENAME>
<SURNAME>Meloni</SURNAME>
<TITLE/>
<EMAIL>Dante.Meloni@ssc.si</EMAIL>
<TEL>+01 040 0331 3231</TEL>
<CERTDN>/C=00/O=00000/OU=000000/CN=Dante Meloni</CERTDN>
<ROLE_NAME>Regional Staff (ROD)</ROLE_NAME>
</CONTACT>
</ROC>
Expand Down
6 changes: 4 additions & 2 deletions api/read/get_roc_list/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_DE` |
| `roc` | Limit results to given NGI | any NGI name | `all` | `?method=get_roc_list&roc=NGI_SI` |

### Paging

Expand All @@ -25,6 +25,8 @@ This method does not support paging.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<ROC PRIMARY_KEY="4G0" ROC_NAME="EGI.eu"/>
<ROC PRIMARY_KEY="2G0" ROC_NAME="NGI_CH"/>
<ROC PRIMARY_KEY="3G0" ROC_NAME="NGI_SI"/>
<ROC PRIMARY_KEY="4G0" ROC_NAME="NGI_HU"/>
</results>
```
63 changes: 28 additions & 35 deletions api/read/get_service/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

| Parameters | Effect | Format/Value(s) | Default | Example |
| - | - | - | - | - |
| `hostname` | Limit results to services hosted on node with given hostname | any host name | `all` | `?method=get_service_endpoint&hostname=dcache-tape.gridpp.rl.ac.uk` |
| `sitename` | Only return info for site with specified site name | any site name | `all` |`?method=get_site&sitename=RAL-LCG2` |
| `roc` | 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` |
| `service_type` | Limit results to services of given type | any valid ServiceType | `all` | `?method=get_service_endpoint&service_type=CE` |
| `hostname` | Limit results to services hosted on node with given hostname | any host name | `all` | `?method=get_service_endpoint&hostname=bdii.ipb.ac.rs` |
| `sitename` | Only return info for site with specified site name | any site name | `all` |`?method=get_site&sitename=Izola MRF` |
| `roc` | Limit results to sites belonging to given NGI | any NGI name | `all` | `?method=get_site&roc=NGI_SI` |
| `country` | Limit results to sites belonging to given country | any country | `all` | `?method=get_site&country=Slovenia` |
| `service_type` | Limit results to services of given type | any valid ServiceType | `all` | `?method=get_service_endpoint&service_type=ARC-CE` |
| `monitored` | Limit results to services hosted on nodes that have monitoring turned on | `Y` or `N` | `all` | `?method=get_service_endpoint&monitored=Y` |
| `scope` | Show only sites with the requested scope tags | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. `&scope=` | instance dependant | `?method=get_site&scope=Local` |
| `scope` | Show only sites with the requested scope tags | A comma separated list of scope-tag values or an empty value to return all scopes, i.e. `&scope=` | instance dependant | `?method=get_site&scope=EGI` |
| `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](https://docs.egi.eu/internal/configuration-database/extension-properties/) | none | `?method=get_site&extensions=(KeyName=KeyValue)` |

Expand All @@ -39,44 +39,37 @@ This method does not support paging.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<results>
<SERVICE_ENDPOINT PRIMARY_KEY="4180G0">
<PRIMARY_KEY>4180G0</PRIMARY_KEY>
<HOSTNAME>gocdb.example.com</HOSTNAME>
<GOCDB_PORTAL_URL>/portal/index.php?Page_Type=Service&id=4180</GOCDB_PORTAL_URL>
<HOSTDN>/DC=org/DC=terena/DC=tcs/C=NL/L=Amsterdam/O=Stichting EGI/gocdb.example.com</HOSTDN>
<HOST_ARCH>x86_64</HOST_ARCH>
<SERVICE_ENDPOINT PRIMARY_KEY="1G0">
<PRIMARY_KEY>1G0</PRIMARY_KEY>
<HOSTNAME>lodur.torchit.ch</HOSTNAME>
<GOCDB_PORTAL_URL>https://localhost/portal/index.php?Page_Type=Service&amp;id=1</GOCDB_PORTAL_URL>
<HOSTDN>/DC=com/DC=quovadisglobal/DC=grid/DC=Torch/DC=hosts/C=CH/ST=Zuerich/L=Zuerich/O=SWITCH/CN=lodur.torchit.ch</HOSTDN>
<HOST_OS>SL5</HOST_OS>
<HOST_ARCH>64 bit</HOST_ARCH>
<BETA>N</BETA>
<SERVICE_TYPE>egi.GOCDB</SERVICE_TYPE>
<SERVICE_TYPE>Local-LFC</SERVICE_TYPE>
<HOST_IP>130.59.111.49</HOST_IP>
<CORE/>
<IN_PRODUCTION>Y</IN_PRODUCTION>
<NODE_MONITORED>Y</NODE_MONITORED>
<NOTIFICATIONS>Y</NOTIFICATIONS>
<SITENAME>GRIDOPS-GOCDB</SITENAME>
<COUNTRY_NAME>United Kingdom</COUNTRY_NAME>
<COUNTRY_CODE>GB</COUNTRY_CODE>
<ROC_NAME>EGI.eu</ROC_NAME>
<URL>https://gocdb.example.com:443</URL>
<IN_PRODUCTION>N</IN_PRODUCTION>
<NODE_MONITORED>N</NODE_MONITORED>
<NOTIFICATIONS>N</NOTIFICATIONS>
<SITENAME>Torch</SITENAME>
<COUNTRY_NAME>Switzerland</COUNTRY_NAME>
<COUNTRY_CODE>CH</COUNTRY_CODE>
<ROC_NAME>NGI_CH</ROC_NAME>
<URL/>
<ENDPOINTS>
<ENDPOINT>
<ID>6313</ID>
<NAME>ProductionPortalInstance</NAME>
<ID>1</ID>
<NAME>sampleEndpoint</NAME>
<EXTENSIONS/>
<URL>https://gocdb.example.com/portal</URL>
<INTERFACENAME>egi.GOCDB.Portal</INTERFACENAME>
<ENDPOINT_MONITORED>N</ENDPOINT_MONITORED>
</ENDPOINT>
<ENDPOINT>
<ID>6314</ID>
<NAME>Production PI base url</NAME>
<EXTENSIONS/>
<URL>https://gocdb.example.com/gocdbpi</URL>
<INTERFACENAME>egi.GOCDB.PI</INTERFACENAME>
<URL/>
<INTERFACENAME>Local-LFC</INTERFACENAME>
<ENDPOINT_MONITORED>N</ENDPOINT_MONITORED>
</ENDPOINT>
</ENDPOINTS>
<SCOPES>
<SCOPE>EGI</SCOPE>
<SCOPE>EGICore</SCOPE>
<SCOPE>Local</SCOPE>
</SCOPES>
<EXTENSIONS/>
</SERVICE_ENDPOINT>
Expand Down
Loading