diff --git a/scs_api.server_public.md b/scs_api.server_public.md index 582c213705679d87a6ae321055451701e9588aa7..d79323e35e5a6da6be20bed7dfd4912f12035765 100644 --- a/scs_api.server_public.md +++ b/scs_api.server_public.md @@ -15,11 +15,11 @@ is 6 requests per minute. Exceeding the limit will lead to your IP address being temporarily blocked from making further requests. The block will automatically be lifted by waiting an hour. -- api revision: `6ecb1bb3 / 2022-05-10 13:51:59 +0200` +- api revision: `cd50bb09 / 2022-05-26 15:01:17 +0200` -- api version: `1.0-33-g6ecb1bb` +- api version: `1.0-34-gcd50bb0` -- apidoc building date: `2022-05-10 11:55:40 +0000` +- apidoc building date: `2022-05-26 13:03:00 +0000` Summary ------------------------------------------------------------------------------------- @@ -271,14 +271,11 @@ Status Codes **POST /api/v1/it4ifree/**(login) A service to check resources of the projects on which the account -participates. If the calculation runs on 1 CPU core for 1 hour, it -consumes 1 core-hour from the project’s resources. However, some -calculations (or their placement) can be cheaper. Actual consumed -core-hours are reduced by a cheapening factor and then deducted from the -project’s resources. See -<a href="https://docs.it4i.cz/general/resources-allocation-policy/#normalized-core-hours-nch" class="reference external">link</a> -for more details about so-called normalized core-hours. The JSON -response contains two parts: +participates. If the calculation runs on 1 node core for 1 hour, it +consumes 1 node-hour from the project’s resources. See +<a href="https://docs.it4i.cz/general/resources-allocation-policy/" class="reference external">link</a> +for more details about so-called node-hours. The JSON response contains +two parts: - `me` – data from projects, where the account has access > @@ -302,29 +299,21 @@ Response JSON Object - **pid** (*string*) – project id -- **type** (*string*) – project type, S for standard, M-1, M-2, M-3, - M-4 for multiyear project in particular period +- **type** (*string*) – project resource type, eg.: Karolina CPU, + Barbora GPU, DGX-2,… project in particular period - **days\_left** (*string*) – days to the end of project, or inactive, expired, forthcoming, upcoming, unlimited -- **free** (*int*) – free core-hours which can still be consumed +- **free** (*int*) – free node-hours which can still be consumed -- **total** (*int*) – total core-hours assigned to the project +- **total** (*int*) – total node-hours assigned to the project -- **used** (*int*) – actual consumed core-hours +- **used** (*int*) – actual consumed node-hours -- **used\_with\_factor** (*int*) – consumed normalized core-hours +- **used\_by\_me** (*int*) – node-hours consumed by the account -- **used\_by\_me** (*int*) – core-hours consumed by the account - -- **used\_by\_me\_with\_factor** (*int*) – normalized core-hours - consumed by the account - -- **corehours** (*int*) – core-hours consumed by the account - -- **core\_hours\_with\_factor** (*int*) – normalized core-hours - consumed by the account +- **nodehours** (*int*) – core-hours consumed by the account Status Codes @@ -348,55 +337,38 @@ Status Codes { "me": [ { - "days_left": "---", - "free": 17124, - "login": "johnsm", - "pid": "DD-13-6", - "total": 100000, - "type": "S", - "used": 82876, - "used_by_me": 0, - "used_by_me_with_factor": 0, - "used_with_factor":82876 + "by_me":0.0, + "days_left":"244", + "free":7434148.1, + "pid":"DD-13-6", + "resource_type":"Legacy Normalized Core Hours", + "total":7470000.0, + "used":35851.9 }, { - "days_left": "---", - "free": 0, - "login": "johnsm", - "pid": "DD-14-12", - "total": 1000, - "used": 8641, - "type": "S", - "used_by_me": 0, - "used_by_me_with_factor": 0, - "used_with_factor": 8641 - } + "by_me":32.4, + "days_left":"220", + "free":67.6, + "pid":"DD-1-1", + "resource_type":"Barbora CPU", + "total":100.0, + "used":32.4 + }, + ], "me_as_pi": [ - { - "core_hours": 82876, - "core_hours_with_factor": 82876, - "login":"abc", - "pi_login": "johnsm", - "pid": "DD-13-6", - "type": "S" + {"login":"johnsm", + "pid":"DD-13-6", + "resource_type":"Legacy Normalized Core Hours", + "total":7470000.0, + "usage":35851.9 }, - { - "core_hours": 0, - "core_hours_with_factor": 0, - "login": "johnsm", - "pi_login": "johnsm", - "pid":"DD-13-6", - "type": "S" + {"login":"johnsm", + "pid":"DD-1-1", + "resource_type":"Barbora CPU", + "total":100.0, + "usage":32.4 }, - { - "core_hours": 0, - "core_hours_with_factor": 0, - "login": "johnsm", - "pi_login": "johnsm", - "pid":"DD-1-1", - "type": "M-1" - } ] }