Skip to content

API Performance

liamie edited this page Nov 19, 2020 · 7 revisions

Home / API / Performance

ReadPrfMemoryAvailable

Reads performance entries. The StartDate and EndDate parameters should use the Sortable Date format with whole minutes and 00 for seconds, i.e. "yyyy-MM-ddTHH:mm:ss"

Authentication: Windows

Privilege : Administrator Method: Security.Performance.Performance_API.ReadPrfMemoryAvailable

Parameters:

Name Type Default Description
PrfDatetimeStart DateTime Start of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").
PrfDatetimeEnd DateTime End of Date/Time range for this read ("YYYY-MM-DDTHH:mm:ss").

Return: Object as below - Alternatively, an array of validation errors

Name Type Default Description
datetime String[] An array of the minutes between the PrfDatetimeStart and PrfDatetimeEnd inclusive
server Object[] An array of server objects consisting of a servernamestring and the array of results for that server at the matching minute to datetime if exists otherwise null.

Return: Example is shown below:

{
    "jsonrpc": "2.0",
    "result": {
        "datetime": [
            "05/11/2020 15:36:00",
            "05/11/2020 15:37:00",
            "05/11/2020 15:38:00"
        ],
        "server": [
            {
                "SERVERNAME": [
                    "0",
                    "0",
                    null
                ]
            }
        ]
    },
}

Clone this wiki locally