qBool GetApiCallSummary( ProtocolCallContext * pContext, qList< ApiCallSummary > * pApiCallSummaryList, PrincipalID principalId, DateTime sinceTime = DateTime::Never, DateTime untilTime = DateTime::Never, qBool isLimitOverOnly = true );
Name | Description | |
---|---|---|
in | pContext |
Call information. |
out | pApiCallSummaryList |
Function call summary information list. |
in | principalId |
Principal ID of the acquisition target. |
in | sinceTime |
Start time. |
in | untilTime |
End time. |
in | isLimitOverOnly |
Whether to get a function call summary only for functions that were called in excess of the call frequency limit. |
Value | Description |
---|---|
true |
RMC call initialization succeeded. |
false |
Failure. |
Totals the API calls in the API call log, and gets whether the API call frequency is within the allowable limit.
Totals the API call information that matches the specified conditions, and then calculates the number of API calls and whether that result is within the limits stipulated in the guidelines.
For the conditions for the function calls to get, you can specify a call time and the principal ID of the called client.
To get a log of calls made after a specified time, specify a value for sinceTime
. Similarly, to get a log of calls made before a specified time, specify a value for untilTime
. If you do not want to specify a time frame, pass DateTime::Never
as the argument.
The asynchronous process might return the following results.
QERROR(RendezVous, InvalidConfiguration)
: The API call log feature has been disabled.
CONFIDENTIAL