SAM3 API DOCUMENTATION

GET latestresultssmry-json

Returns a summary of the latest test results.

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/latestresultssmry-json

Resource Information

Response formats

JSON

Requires authentication?

No

Parameters

profile (required)

The name of the desired profile.

Example value: CMS_CRITICAL

site (required)

The names of the desired sites.

Example value: T0_CH_CERN

flavour (optional)

The names of the desired services.

Example value: SRMv2

metric (optional)

The names of the desired metrics.

Example value: org.cms.SRM-VOGet (/cms/Role_production)

Example Request

GET

http://wlcg-sam-cms.cern.ch/dashboard/request.py/latestresultssmry-json?profile=CMS_CRITICAL&flavour=SRMv2&site=T0_CH_CERN

GET gettopologymin

Returns the topology of a VO

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/gettopologymin

Resource Information

Response formats

JSON, XML

Requires authentication?

No

Parameters

vo_name (optional)

The name of the desired vo.

Example values: atlas, cms, alice or lhcb

Default value: <experiment> in the url

Example Request

GET

http://wlcg-sam-lhcb.cern.ch/dashboard/request.py/gettopologymin

GET getallprofilesandservices

Returns the services for each profile of a vo.

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/getallprofilesandservices

Resource Information

Response formats

JSON

Requires authentication?

No

Parameters

vo_name (optional)

The name of the desired vo.

Expected values: atlas, cms, alice or lhcb

Default value: <experiment> in the url

Example Request

GET

http://wlcg-sam-cms.cern.ch/dashboard/request.py/getallprofilesandservices?vo_name=alice

GET getTestResults

Returns the test history for a host

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/getTestResults

Resource Information

Response formats

JSON, XML

Requires authentication?

No

Parameters

profile (required)

The name of the desired profile.

Example value: CMS_CRITICAL

time_range (optional)

The desired time range.

Expected values: last12, last24, last48, lastWeek, last2Weeks or lastMonth.

start_time (optional)

The desired start time.

Needs end_time.

Example value: 2015-01-28T00:00:00Z

end_time (optional)

The desired end time.

Needs start_time.

Example value: 2015-01-29T00:00:00Z

flavour (required)

The names of the desired services.

Example value: SRMv2

metric (required)

The names of the desired metrics or "All".

Example value: org.cms.SRM-VOGet (/cms/Role_production)

hostname (required)

The name of the desired host.

Example value: srm-cms.cern.ch

Example Request

GET

http://wlcg-sam-cms.cern.ch/dashboard/request.py/getTestResults?profile_name=CMS_CRITICAL&time_range=last12&flavours=SRMv2&metrics=org.cms.SRM-GetPFNFromTFC (/cms/Role_production)&hostname=srm-cms.cern.ch

GET getstatsresultsmin

Returns the stats of availabilities and reliabilities for sites and services.

Use GET getstatsresults for a different formatted json.

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/getstatsresultsmin

Resource Information

Response formats

JSON

Requires authentication?

No

Parameters

profile_name (required)

The name of the desired profile.

Example value: CMS_CRITICAL

group_name (required)

The names of the desired sites.

Example value: T1_DE_KIT

granularity (required)

The desired granularity.

Expected values: hourly, daily or default.

time_range (optional)

The desired time range.

Expected values: last12, last24, last48, lastWeek, last2Weeks or lastMonth.

start_time (optional)

The desired start time.

Needs end_time.

Example value: 2015-01-28T00:00:00Z

end_time (optional)

The desired end time.

Needs start_time.

Example value: 2015-01-29T00:00:00Z

view (optional)

The desired view.

Default value: siteavl

Expected values: siteavl, siterel, serviceavl or servicerel

flavour (required if view is serviceavl or servicerel)

The names of the desired services.

Example value: SRMv2

hosts (required if view is serviceavl or servicerel)

The name of the site + the name of the host.

Example value: T1_DE_KIT+cream-ge-8-kit.gridka.de

Example Request

GET

http://wlcg-sam-cms.cern.ch/dashboard/request.py/getstatsresultsmin?profile_name=CMS_CRITICAL&group_name=T1_DE_KIT&view=siteavl&time_range=last12&granularity=default

GET metricOutput

Returns the detailed output of a metric result.

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/metricOutput

Resource Information

Response formats

JSON, CSV, HTML, XML

Requires authentication?

No

Parameters

host (required)

The name of the desired host.

Example value: ce301.cern.ch

metricfqan (required)

The name of the desired metricfqan.

Example value: org.cms.glexec.WN-gLExec (/cms/Role_pilot)

time (required)

The desired time.

Example value: 2015-01-30T08:56:11Z

It is possible to ask for the "lastone". Needs flavour.

flavour (optional)

The desired flavour.

Example value: OSG-SRMv2

Example Request

GET

http://wlcg-sam-cms.cern.ch/dashboard/request.py/metricOutput?host=ce301.cern.ch&metricfqan=org.cms.glexec.WN-gLExec (/cms/Role_pilot)&time=2015-01-30T08:56:11Z

GET reportsGeneration

Returns the WLCG Reports for the Site Usability Interface (SAM3) UI.

Resource URL

http://wlcg-sam-<experiment>.cern.ch/dashboard/request.py/reportsGeneration

Resource Information

Response formats

HTML, PDF

Requires authentication?

No

Parameters

report (required)

The report type desired.

Expected values: all, history, summary or vo

vo (required)

The vo desired.

Expected values: alice, atlas, cms or lhcb

type (required)

The report type desired.

Expected values: html or pdf

start_time (required)

The start time desired.

Example value: 23-Jan-2015

end_time (required)

The end time desired.

Example value: 30-Jan-2015

Example Request

GET

http://wlcg-sam-lhcb/dashboard/request.py/reportsGeneration?report=all&vo=alice&start_time=23-Jan-2015&end_time=30-Jan-2015&type=html