(Click to open topic with navigation)

5.231 Fairshare

This section describes behavior of the Fairshare object in Moab Web Services. It contains the URLs, request bodies, and responses delivered to and from MWS.

The supported methods table below requires each resource to be accessed with a URL parameter of api-version=3.

For more information, see Requesting Specific API Versions.

Supported methods

Resource GET PUT POST DELETE
/rest/policies/fairshare Get All Fairshare Interval Data -- -- --
/rest/policies/fairshare/<credentialType> Get all Fairshare Interval Data for a Single Credential Type -- -- --
/rest/policies/fairshare/<credentialType>/<name> Get all Fairshare Interval Data for a Single Credential -- -- --

This topic contains these sections:

5.231.1 Getting Credential-Based Fairshare Interval Data

The HTTP GET method is used to retrieve Policies information.

Quick reference

GET http://localhost:8080/mws/rest/policies/fairshare/credentials?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/accounts?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/classes?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/groups?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/qoses?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/users?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/accounts/<name>?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/classes/<name>?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/groups/<name>?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/qoses/<name>?api-version=3
GET http://localhost:8080/mws/rest/policies/fairshare/credentials/users/<name>?api-version=3

5.231.1.A Get All Fairshare Interval Data

URLs and parameters

GET http://localhost:8080/mws/rest/policies/fairshare/credentials?api-version=3

See Global URL Parameters for available URL parameters.

Sample response

GET http://localhost:8080/mws/rest/policies/fairshare/credentials?api-version=3
------------------------------------

{
  "totalCount": 4,
  "resultCount": 4,
  "results":   [
    {
      "name": "jbethune",
      "target_type": null,
      "target": null,
      "interval_data":       [
        0,
        0,
        0,
        0
      ],
      "credential_type": "USER"
    },
    {
      "name": "jfoote",
      "target_type": null,
      "target": null,
      "interval_data":       [
        2104.16,
        2377.06,
        2240.1,
        2550
      ],
      "credential_type": "GROUP"
    },
    {
      "name": "NOGROUP",
      "target_type": null,
      "target": null,
      "interval_data":       [
        0,
        0,
        0,
        0
      ],
      "credential_type": "GROUP"
    },
    {
      "name": "DEFAULT",
      "target_type": null,
      "target": null,
      "interval_data":       [
        0,
        0,
        0,
        0
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Administration",
      "target_type": null,
      "target": null,
      "interval_data":       [
        5256.28,
        6247.05,
        6048.27,
        6948.67
      ],
      "credential_type": "ACCOUNT"    
    }
  ]

}

5.231.1.B Get all Fairshare Interval Data for a Single Credential Type

URLs and parameters

GET http://localhost:8080/mws/rest/policies/fairshare/credentials/<accounts|classes|groups|qoses|users>?api-version=3

See Global URL Parameters for available URL parameters.

Sample responses

GET http://localhost:8080/mws/rest/policies/fairshare/credentials/accounts?api-version=3
------------------------------------

{
  "totalCount": 6,
  "resultCount": 6,
  "results":   [
    {
      "name": "jbethune",
      "target_type": null,
      "target": null,
      "interval_data":       [
        0,
        0,
        0,
        0
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Administration",
      "target_type": null,
      "target": null,
      "interval_data":       [
        5256.28,
        6247.05,
        6048.27,
        6948.67
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Shared",
      "target_type": null,
      "target": null,
      "interval_data":       [
        4261.38,
        4951.09,
        4480.2,
        5000.54
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Engineering",
      "target_type": null,
      "target": null,
      "interval_data":       [
        15034.64,
        17245.93,
        15008.67,
        17085
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Test",
      "target_type": null,
      "target": null,
      "interval_data":       [
        1808.08,
        1873.96,
        1568.07,
        1757.33
      ],
      "credential_type": "ACCOUNT"
    },
    {
      "name": "Research",
      "target_type": null,
      "target": null,
      "interval_data":       [
        47606.8,
        52861.83,
        46370.07,
        52785
      ],
      "credential_type": "ACCOUNT"
    }
  ]

}

5.231.1.C Get all Fairshare Interval Data for a Single Credential

URLs and parameters

GET http://localhost:8080/mws/rest/policies/fairshare/credentials/<accounts|classes|groups|qoses|users>/<name>?api-version=3
Parameter Required Type Valid values Description
name Yes String -- The unique name of the object.

See Global URL Parameters for available URL parameters.

Sample response

GET http://localhost:8080/mws/rest/policies/fairshare/credentials/accounts/DEFAULT?api-version=3
------------------------------------
{
  "name": "DEFAULT",
  "target_type": null,
  "target": null,
  "interval_data":   [
    0,
    0,
    0,
    0
  ],
  "credential_type": "ACCOUNT"
}

Related Topics 

© 2016 Adaptive Computing