sdkms.v1.apis.stats_api module

Fortanix DSM REST API

This is a set of REST APIs for accessing the Fortanix Data Security Manager. This includes APIs for managing accounts, and for performing cryptographic and key management operations.

OpenAPI spec version: 1.0.0-20200608 Contact: support@fortanix.com Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class sdkms.v1.apis.stats_api.StatsApi(api_client=None)[source]

Bases: object

__init__(api_client=None)[source]
get_app_stats(app_id, range_from=None, range_to=None, num_points=None, async_call=False, **kwargs)[source]

This API is for obtaining transaction statistics for a specific application. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • app_id (str) – Application Identifier (required)

  • range_from (int) – Starting time for search , this is EPOCH value

  • range_to (int) – Ending time for search , this is EPOCH value

  • num_points (int) – Number of data points desired

Return type:

StatsResponse

Returns:

If the method is called asynchronously, returns the request thread.

get_apps_stats(range_from=None, range_to=None, top_count=None, num_points=None, async_call=False, **kwargs)[source]

This is for obtaining app level aggregate transaction statistics to find top apps by transaction. API supports query parameters for fetchings stats for specific time period, for maximum top count and with number of data points desired.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • range_from (int) – Starting time for search , this is EPOCH value

  • range_to (int) – Ending time for search , this is EPOCH value

  • top_count (int) – Maximum top count for statistics query

  • num_points (int) – Number of data points desired

Return type:

StatsResponse

Returns:

If the method is called asynchronously, returns the request thread.

get_group_stats(group_id, range_from=None, range_to=None, num_points=None, async_call=False, **kwargs)[source]

This API is for obtaining transaction statistics for a specific group. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • group_id (str) – Group Identifier (required)

  • range_from (int) – Starting time for search , this is EPOCH value

  • range_to (int) – Ending time for search , this is EPOCH value

  • num_points (int) – Number of data points desired

Return type:

StatsResponse

Returns:

If the method is called asynchronously, returns the request thread.

get_groups_stats(range_from=None, range_to=None, top_count=None, num_points=None, async_call=False, **kwargs)[source]

This is for obtaining group level aggregate transaction statistics to find top groups by transaction. API supports query parameters for fetchings stats for specific time period, for maximum top count and with number of data points desired.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • range_from (int) – Starting time for search , this is EPOCH value

  • range_to (int) – Ending time for search , this is EPOCH value

  • top_count (int) – Maximum top count for statistics query

  • num_points (int) – Number of data points desired

Return type:

StatsResponse

Returns:

If the method is called asynchronously, returns the request thread.

get_security_object_stats(key_id, range_from=None, range_to=None, num_points=None, async_call=False, **kwargs)[source]

This API is for obtaining transaction statistics for a specific security object. API supports query parameters for fetchings stats for specific time period and with number of data points desired.

Parameters:

  • async_call (bool) – Whether the call should be performed asynchronously. (Default is False).

  • key_id (str) – kid of security object (required)

  • range_from (int) – Starting time for search , this is EPOCH value

  • range_to (int) – Ending time for search , this is EPOCH value

  • num_points (int) – Number of data points desired

Return type:

StatsResponse

Returns:

If the method is called asynchronously, returns the request thread.