rcabench 1.1.2

RCABench SDK

rcabench

RCABench - A comprehensive root cause analysis benchmarking platform for microservices This API provides endpoints for managing datasets, algorithms, evaluations, and fault injections for root cause analysis in distributed systems and microservices architectures.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import rcabench

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rcabench

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import time
import rcabench
from rcabench.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = rcabench.Configuration(
    host = "http://localhost:8080/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: BearerAuth
configuration.api_key['BearerAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['BearerAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with rcabench.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rcabench.AlgorithmsApi(api_client)
    algorithm_id = 56 # int | Algorithm ID
    execution_id = 56 # int | Execution ID
    request = rcabench.DtoDetectorResultRequest() # DtoDetectorResultRequest | Detector results

    try:
        # Upload detector algorithm results
        api_response = api_instance.api_v2_algorithms_algorithm_id_executions_execution_id_detectors_post(algorithm_id, execution_id, request)
        print("The response of AlgorithmsApi->api_v2_algorithms_algorithm_id_executions_execution_id_detectors_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlgorithmsApi->api_v2_algorithms_algorithm_id_executions_execution_id_detectors_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v1

Class	Method	HTTP request	Description
AlgorithmsApi	api_v2_algorithms_algorithm_id_executions_execution_id_detectors_post	POST /api/v2/algorithms/{algorithm_id}/executions/{execution_id}/detectors	Upload detector algorithm results
AlgorithmsApi	api_v2_algorithms_algorithm_id_executions_execution_id_results_post	POST /api/v2/algorithms/{algorithm_id}/executions/{execution_id}/results	Upload granularity algorithm results
AlgorithmsApi	api_v2_algorithms_algorithm_id_results_post	POST /api/v2/algorithms/{algorithm_id}/results	Upload granularity algorithm results
AlgorithmsApi	api_v2_algorithms_get	GET /api/v2/algorithms	List algorithms
AlgorithmsApi	api_v2_algorithms_search_post	POST /api/v2/algorithms/search	Search algorithms
AuthenticationApi	api_v2_auth_change_password_post	POST /api/v2/auth/change-password	Change user password
AuthenticationApi	api_v2_auth_login_post	POST /api/v2/auth/login	User login
AuthenticationApi	api_v2_auth_logout_post	POST /api/v2/auth/logout	User logout
AuthenticationApi	api_v2_auth_profile_get	GET /api/v2/auth/profile	Get current user profile
AuthenticationApi	api_v2_auth_refresh_post	POST /api/v2/auth/refresh	Refresh JWT token
AuthenticationApi	api_v2_auth_register_post	POST /api/v2/auth/register	User registration
ContainersApi	api_v2_containers_get	GET /api/v2/containers	List containers
ContainersApi	api_v2_containers_id_delete	DELETE /api/v2/containers/{id}	Delete container
ContainersApi	api_v2_containers_id_get	GET /api/v2/containers/{id}	Get container by ID
ContainersApi	api_v2_containers_id_put	PUT /api/v2/containers/{id}	Update container
ContainersApi	api_v2_containers_post	POST /api/v2/containers	Create or update container
ContainersApi	api_v2_containers_search_post	POST /api/v2/containers/search	Search containers
DatasetsApi	api_v2_datasets_get	GET /api/v2/datasets	List datasets
DatasetsApi	api_v2_datasets_id_delete	DELETE /api/v2/datasets/{id}	Delete dataset
DatasetsApi	api_v2_datasets_id_get	GET /api/v2/datasets/{id}	Get dataset by ID
DatasetsApi	api_v2_datasets_id_injections_patch	PATCH /api/v2/datasets/{id}/injections	Manage dataset injections
DatasetsApi	api_v2_datasets_id_labels_patch	PATCH /api/v2/datasets/{id}/labels	Manage dataset labels
DatasetsApi	api_v2_datasets_id_put	PUT /api/v2/datasets/{id}	Update dataset
DatasetsApi	api_v2_datasets_post	POST /api/v2/datasets	Create dataset
DatasetsApi	api_v2_datasets_search_post	POST /api/v2/datasets/search	Search datasets
InjectionsApi	api_v2_injections_get	GET /api/v2/injections	List injections
InjectionsApi	api_v2_injections_id_delete	DELETE /api/v2/injections/{id}	Delete injection
InjectionsApi	api_v2_injections_id_get	GET /api/v2/injections/{id}	Get injection by ID
InjectionsApi	api_v2_injections_id_put	PUT /api/v2/injections/{id}	Update injection
InjectionsApi	api_v2_injections_post	POST /api/v2/injections	Create injections
InjectionsApi	api_v2_injections_search_post	POST /api/v2/injections/search	Search injections
PermissionsApi	api_v2_permissions_get	GET /api/v2/permissions	List permissions
PermissionsApi	api_v2_permissions_id_delete	DELETE /api/v2/permissions/{id}	Delete permission
PermissionsApi	api_v2_permissions_id_get	GET /api/v2/permissions/{id}	Get permission by ID
PermissionsApi	api_v2_permissions_id_put	PUT /api/v2/permissions/{id}	Update permission
PermissionsApi	api_v2_permissions_id_roles_get	GET /api/v2/permissions/{id}/roles	Get permission roles
PermissionsApi	api_v2_permissions_post	POST /api/v2/permissions	Create a new permission
PermissionsApi	api_v2_permissions_resource_resource_id_get	GET /api/v2/permissions/resource/{resource_id}	Get permissions by resource
PermissionsApi	api_v2_permissions_search_post	POST /api/v2/permissions/search	Search permissions
RelationsApi	api_v2_relations_batch_post	POST /api/v2/relations/batch	Batch relationship operations
RelationsApi	api_v2_relations_get	GET /api/v2/relations	List relationships
RelationsApi	api_v2_relations_role_permissions_delete	DELETE /api/v2/relations/role-permissions	Remove permissions from role
RelationsApi	api_v2_relations_role_permissions_post	POST /api/v2/relations/role-permissions	Assign permissions to role
RelationsApi	api_v2_relations_statistics_get	GET /api/v2/relations/statistics	Get relationship statistics
RelationsApi	api_v2_relations_user_permissions_delete	DELETE /api/v2/relations/user-permissions	Remove permission from user
RelationsApi	api_v2_relations_user_permissions_post	POST /api/v2/relations/user-permissions	Assign permission to user
RelationsApi	api_v2_relations_user_roles_delete	DELETE /api/v2/relations/user-roles	Remove role from user
RelationsApi	api_v2_relations_user_roles_post	POST /api/v2/relations/user-roles	Assign role to user
RolesApi	api_v2_roles_get	GET /api/v2/roles	List roles
RolesApi	api_v2_roles_id_delete	DELETE /api/v2/roles/{id}	Delete role
RolesApi	api_v2_roles_id_get	GET /api/v2/roles/{id}	Get role by ID
RolesApi	api_v2_roles_id_permissions_delete	DELETE /api/v2/roles/{id}/permissions	Remove permissions from role
RolesApi	api_v2_roles_id_permissions_post	POST /api/v2/roles/{id}/permissions	Assign permissions to role
RolesApi	api_v2_roles_id_put	PUT /api/v2/roles/{id}	Update role
RolesApi	api_v2_roles_id_users_get	GET /api/v2/roles/{id}/users	Get role users
RolesApi	api_v2_roles_post	POST /api/v2/roles	Create a new role
RolesApi	api_v2_roles_search_post	POST /api/v2/roles/search	Search roles
SystemApi	api_v2_audit_get	GET /api/v2/audit	List audit logs
SystemApi	api_v2_audit_id_get	GET /api/v2/audit/{id}	Get audit log by ID
SystemApi	api_v2_audit_post	POST /api/v2/audit	Create audit log
SystemApi	api_v2_health_get	GET /api/v2/health	System health check
SystemApi	api_v2_monitor_info_get	GET /api/v2/monitor/info	Get system information
SystemApi	api_v2_monitor_metrics_post	POST /api/v2/monitor/metrics	Get monitoring metrics
SystemApi	api_v2_statistics_get	GET /api/v2/statistics	Get system statistics
TasksApi	api_v2_tasks_get	GET /api/v2/tasks	List tasks
TasksApi	api_v2_tasks_id_get	GET /api/v2/tasks/{id}	Get task by ID
TasksApi	api_v2_tasks_queue_post	POST /api/v2/tasks/queue	Get queued tasks
TasksApi	api_v2_tasks_search_post	POST /api/v2/tasks/search	Search tasks
UsersApi	api_v2_users_get	GET /api/v2/users	List users
UsersApi	api_v2_users_id_delete	DELETE /api/v2/users/{id}	Delete user
UsersApi	api_v2_users_id_get	GET /api/v2/users/{id}	Get user by ID
UsersApi	api_v2_users_id_projects_post	POST /api/v2/users/{id}/projects	Assign user to project
UsersApi	api_v2_users_id_projects_project_id_delete	DELETE /api/v2/users/{id}/projects/{project_id}	Remove user from project
UsersApi	api_v2_users_id_put	PUT /api/v2/users/{id}	Update user
UsersApi	api_v2_users_post	POST /api/v2/users	Create a new user
UsersApi	api_v2_users_search_post	POST /api/v2/users/search	Search users
AlgorithmApi	api_v1_algorithms_get	GET /api/v1/algorithms	Get algorithm list
AlgorithmApi	api_v1_algorithms_post	POST /api/v1/algorithms	Submit algorithm execution task
AnalyzerApi	api_v1_analyzers_injections_get	GET /api/v1/analyzers/injections	Analyze fault injection data
ContainerApi	api_v1_containers_post	POST /api/v1/containers	Submit container build task
DatasetApi	api_v1_datasets_delete	DELETE /api/v1/datasets	Delete dataset data
DatasetApi	api_v1_datasets_download_get	GET /api/v1/datasets/download	Download dataset archive file
DatasetApi	api_v1_datasets_post	POST /api/v1/datasets	Batch build datasets
DebugApi	api_v1_debug_ns_status_get	GET /api/v1/debug/ns/status	Get namespace lock status
EvaluationApi	api_v1_evaluations_executions_get	GET /api/v1/evaluations/executions	Get successful algorithm execution records
EvaluationApi	api_v1_evaluations_groundtruth_post	POST /api/v1/evaluations/groundtruth	Get ground truth for datasets
EvaluationApi	api_v1_evaluations_raw_data_post	POST /api/v1/evaluations/raw-data	Get raw evaluation data
InjectionApi	api_v1_injections_analysis_no_issues_get	GET /api/v1/injections/analysis/no-issues	Query Fault Injection Records Without Issues
InjectionApi	api_v1_injections_analysis_stats_get	GET /api/v1/injections/analysis/stats	Get Fault Injection Statistics
InjectionApi	api_v1_injections_analysis_with_issues_get	GET /api/v1/injections/analysis/with-issues	Query Fault Injection Records With Issues
InjectionApi	api_v1_injections_conf_get	GET /api/v1/injections/conf	Get Fault Injection Configuration
InjectionApi	api_v1_injections_configs_get	GET /api/v1/injections/configs	Get Injected Fault Configuration List
InjectionApi	api_v1_injections_get	GET /api/v1/injections	Get Fault Injection Record List
InjectionApi	api_v1_injections_mapping_get	GET /api/v1/injections/mapping	Get Field Mapping
InjectionApi	api_v1_injections_ns_resources_get	GET /api/v1/injections/ns-resources	Get Namespace Resource Mapping
InjectionApi	api_v1_injections_post	POST /api/v1/injections	Submit Fault Injection Task
InjectionApi	api_v1_injections_query_get	GET /api/v1/injections/query	Query Single Fault Injection Record
InjectionApi	api_v1_injections_task_id_cancel_put	PUT /api/v1/injections/{task_id}/cancel	Cancel Fault Injection Task
TaskApi	api_v1_tasks_get	GET /api/v1/tasks	Get task list
TaskApi	api_v1_tasks_queue_get	GET /api/v1/tasks/queue	Get queued tasks
TaskApi	api_v1_tasks_task_id_get	GET /api/v1/tasks/{task_id}	Get task detail
TraceApi	api_v1_analyzers_traces_get	GET /api/v1/analyzers/traces	Analyze trace data
TraceApi	api_v1_traces_completed_get	GET /api/v1/traces/completed	Get completed traces

Documentation For Models

• ConstsTaskType
• DatabaseContainer
• DatabaseFaultInjectionSchedule
• DatabaseLabel
• DatabaseProject
• DatabaseTask
• DatabaseUser
• DtoAdvancedSearchRequest
• DtoAlgorithmDatasetPair
• DtoAlgorithmItem
• DtoAlgorithmResponse
• DtoAlgorithmResultUploadResponse
• DtoAlgorithmSearchRequest
• DtoAnalyzeInjectionsResp
• DtoAssignUserPermissionRequest
• DtoAssignUserRoleRequest
• DtoAssignUserToProjectRequest
• DtoAttributeCoverageItem
• DtoAuditLogListResponse
• DtoAuditLogRequest
• DtoAuditLogResponse
• DtoBatchRelationRequest
• DtoChangePasswordRequest
• DtoContainerResponse
• DtoContainerSearchRequest
• DtoContainerStatistics
• DtoCreatePermissionRequest
• DtoCreateRoleRequest
• DtoCreateUserRequest
• DtoDatasetBuildPayload
• DtoDatasetDeleteResp
• DtoDatasetSearchResponse
• DtoDatasetStatistics
• DtoDatasetV2CreateReq
• DtoDatasetV2InjectionManageReq
• DtoDatasetV2InjectionRelationResponse
• DtoDatasetV2LabelCreateReq
• DtoDatasetV2LabelManageReq
• DtoDatasetV2Response
• DtoDatasetV2SearchReq
• DtoDatasetV2UpdateReq
• DtoDateRange
• DtoDateRangeFilter
• DtoDetectorResultItem
• DtoDetectorResultRequest
• DtoExecutionPayload
• DtoExecutionStatistics
• DtoFaultInjectionNoIssuesResp
• DtoFaultInjectionWithIssuesResp
• DtoFilterOperator
• DtoGenericResponseAny
• DtoGenericResponseArrayDtoFaultInjectionNoIssuesResp
• DtoGenericResponseArrayDtoFaultInjectionWithIssuesResp
• DtoGenericResponseArrayDtoPermissionResponse
• DtoGenericResponseArrayDtoRoleResponse
• DtoGenericResponseArrayDtoUserResponse
• DtoGenericResponseDtoAlgorithmResultUploadResponse
• DtoGenericResponseDtoAnalyzeInjectionsResp
• DtoGenericResponseDtoAuditLogListResponse
• DtoGenericResponseDtoAuditLogResponse
• DtoGenericResponseDtoContainerResponse
• DtoGenericResponseDtoDatasetDeleteResp
• DtoGenericResponseDtoDatasetSearchResponse
• DtoGenericResponseDtoDatasetV2Response
• DtoGenericResponseDtoGetCompletedMapResp
• DtoGenericResponseDtoGroundTruthResp
• DtoGenericResponseDtoHealthCheckResponse
• DtoGenericResponseDtoInjectCancelResp
• DtoGenericResponseDtoInjectionFieldMappingResp
• DtoGenericResponseDtoInjectionSearchResponse
• DtoGenericResponseDtoInjectionStatsResp
• DtoGenericResponseDtoInjectionV2CreateResponse
• DtoGenericResponseDtoInjectionV2Response
• DtoGenericResponseDtoListAlgorithmsResp
• DtoGenericResponseDtoListInjectionsResp
• DtoGenericResponseDtoListTasksResp
• DtoGenericResponseDtoLoginResponse
• DtoGenericResponseDtoMonitoringMetricsResponse
• DtoGenericResponseDtoNsResourcesResp
• DtoGenericResponseDtoPaginationRespDtoUnifiedTask
• DtoGenericResponseDtoPermissionListResponse
• DtoGenericResponseDtoPermissionResponse
• DtoGenericResponseDtoQueryInjectionResp
• DtoGenericResponseDtoRawDataResp
• DtoGenericResponseDtoRelationListResponse
• DtoGenericResponseDtoRelationStatisticsResponse
• DtoGenericResponseDtoRoleListResponse
• DtoGenericResponseDtoRoleResponse
• DtoGenericResponseDtoSearchResponseDtoAlgorithmResponse
• DtoGenericResponseDtoSearchResponseDtoContainerResponse
• DtoGenericResponseDtoSearchResponseDtoDatasetV2Response
• DtoGenericResponseDtoSearchResponseDtoInjectionV2Response
• DtoGenericResponseDtoSearchResponseDtoPermissionResponse
• DtoGenericResponseDtoSearchResponseDtoRoleResponse
• DtoGenericResponseDtoSearchResponseDtoTaskResponse
• DtoGenericResponseDtoSearchResponseDtoUserResponse
• DtoGenericResponseDtoSubmitInjectionResp
• DtoGenericResponseDtoSubmitResp
• DtoGenericResponseDtoSuccessfulExecutionsResp
• DtoGenericResponseDtoSystemInfo
• DtoGenericResponseDtoSystemStatisticsResponse
• DtoGenericResponseDtoTaskDetailResp
• DtoGenericResponseDtoTaskDetailResponse
• DtoGenericResponseDtoTokenRefreshResponse
• DtoGenericResponseDtoTraceStats
• DtoGenericResponseDtoUserInfo
• DtoGenericResponseDtoUserListResponse
• DtoGenericResponseDtoUserResponse
• DtoGenericResponseHandlerNode
• DtoGenericResponseHandlerResources
• DtoGetCompletedMapResp
• DtoGranularityRecord
• DtoGranularityResultEnhancedRequest
• DtoGranularityResultItem
• DtoGroundTruthReq
• DtoHealthCheckResponse
• DtoInjectionCreateError
• DtoInjectionDiversity
• DtoInjectionFieldMappingResp
• DtoInjectionItem
• DtoInjectionSearchResponse
• DtoInjectionStatistics
• DtoInjectionStats
• DtoInjectionStatsResp
• DtoInjectionV2CreateItem
• DtoInjectionV2CreateReq
• DtoInjectionV2CreateResponse
• DtoInjectionV2Response
• DtoInjectionV2SearchReq
• DtoInjectionV2UpdateReq
• DtoLabelItem
• DtoListInjectionsResp
• DtoLoginRequest
• DtoLoginResponse
• DtoLogoutRequest
• DtoMetricValue
• DtoMonitoringMetricsResponse
• DtoMonitoringQueryRequest
• DtoNumberRange
• DtoPaginationInfo
• DtoPaginationRespDtoUnifiedTask
• DtoPairStats
• DtoPermissionListResponse
• DtoPermissionResponse
• DtoPermissionSearchRequest
• DtoProjectResponse
• DtoProjectStatistics
• DtoQueryInjectionResp
• DtoRawDataItem
• DtoRawDataReq
• DtoRegisterRequest
• DtoRelationEntity
• DtoRelationListResponse
• DtoRelationOperation
• DtoRelationResponse
• DtoRelationStatisticsResponse
• DtoRemoveUserPermissionRequest
• DtoRemoveUserRoleRequest
• DtoResourceResponse
• DtoRetryPolicy
• DtoRoleListResponse
• DtoRoleResponse
• DtoRoleSearchRequest
• DtoSearchFilter
• DtoSearchResponseDtoAlgorithmResponse
• DtoSearchResponseDtoContainerResponse
• DtoSearchResponseDtoDatasetV2Response
• DtoSearchResponseDtoInjectionV2Response
• DtoSearchResponseDtoPermissionResponse
• DtoSearchResponseDtoRoleResponse
• DtoSearchResponseDtoTaskResponse
• DtoSearchResponseDtoUserResponse
• DtoServiceCoverageItem
• DtoServiceInfo
• DtoSizeRangeFilter
• DtoSortDirection
• DtoSortOption
• DtoSubmitDatasetBuildingReq
• DtoSubmitExecutionReq
• DtoSubmitInjectionReq
• DtoSubmitInjectionResp
• DtoSubmitResp
• DtoSuccessfulExecutionItem
• DtoSystemInfo
• DtoSystemStatisticsResponse
• DtoTaskDetailResp
• DtoTaskDetailResponse
• DtoTaskItem
• DtoTaskResponse
• DtoTaskSearchRequest
• DtoTaskStatistics
• DtoTaskV2Response
• DtoTokenRefreshRequest
• DtoTokenRefreshResponse
• DtoTrace
• DtoTraceStats
• DtoUnifiedTask
• DtoUpdateContainerRequest
• DtoUpdatePermissionRequest
• DtoUpdateRoleRequest
• DtoUpdateUserRequest
• DtoUserInfo
• DtoUserListResponse
• DtoUserProjectResponse
• DtoUserResponse
• DtoUserSearchRequest
• DtoUserStatistics
• HandlerGroundtruth
• HandlerNode
• HandlerPair
• HandlerResources

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

[e-mail]