rcabench 1.0.1

RCABench API Python Client - A comprehensive root cause analysis benchmarking platform

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
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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_client

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_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import rcabench_client
from rcabench_client.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_client.Configuration(
    host = "http://localhost:8080/api/v1"
)



# Enter a context with an instance of the API client
with rcabench_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rcabench_client.AlgorithmApi(api_client)
    file = None # bytearray | 算法文件 (zip/tar.gz) (optional)
    algo = 'algo_example' # str | 算法名称 (optional)

    try:
        # 构建算法镜像
        api_response = api_instance.api_v1_algorithms_build_post(file=file, algo=algo)
        print("The response of AlgorithmApi->api_v1_algorithms_build_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlgorithmApi->api_v1_algorithms_build_post: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AlgorithmApi	api_v1_algorithms_build_post	POST /api/v1/algorithms/build	构建算法镜像
AlgorithmApi	api_v1_algorithms_get	GET /api/v1/algorithms	获取算法列表
AlgorithmApi	api_v1_algorithms_post	POST /api/v1/algorithms	执行算法
DatasetApi	api_v1_datasets_delete	DELETE /api/v1/datasets	删除数据集数据
DatasetApi	api_v1_datasets_download_get	GET /api/v1/datasets/download	下载数据集打包文件
DatasetApi	api_v1_datasets_get	GET /api/v1/datasets	分页查询数据集列表
DatasetApi	api_v1_datasets_post	POST /api/v1/datasets	批量构建数据集
DatasetApi	api_v1_datasets_query_get	GET /api/v1/datasets/query	查询单个数据集详情
EvaluationApi	api_v1_evaluations_get	GET /api/v1/evaluations	获取每种算法的执行历史记录
InjectionApi	api_v1_injections_conf_get	GET /api/v1/injections/conf	获取故障注入配置
InjectionApi	api_v1_injections_configs_get	GET /api/v1/injections/configs	获取故障注入配置列表
InjectionApi	api_v1_injections_get	GET /api/v1/injections	分页查询注入记录列表
InjectionApi	api_v1_injections_ns_status_get	GET /api/v1/injections/ns/status	获取命名空间锁状态
InjectionApi	api_v1_injections_post	POST /api/v1/injections	注入故障
InjectionApi	api_v1_injections_query_get	GET /api/v1/injections/query	查询故障注入记录
InjectionApi	api_v1_injections_task_id_cancel_put	PUT /api/v1/injections/{task_id}/cancel	取消故障注入任务
TaskApi	api_v1_tasks_list_get	GET /api/v1/tasks/list	获取任务列表
TaskApi	api_v1_tasks_queue_get	GET /api/v1/tasks/queue	获取队列中的任务
TaskApi	api_v1_tasks_task_id_get	GET /api/v1/tasks/{task_id}	获取任务详情
TraceApi	api_v1_traces_analyze_get	GET /api/v1/traces/analyze	分析链路数据
TraceApi	api_v1_traces_completed_get	GET /api/v1/traces/completed	获取完成状态的链路
TraceApi	api_v1_traces_trace_id_stream_get	GET /api/v1/traces/{trace_id}/stream	获取跟踪流数据

Documentation For Models

• ConstsTaskType
• DtoAlgorithmExecutionPayload
• DtoAlgorithmListResp
• DtoConclusion
• DtoDatasetBuildPayload
• DtoDatasetDeleteResp
• DtoDatasetItem
• DtoDetectorRecord
• DtoEvaluationItem
• DtoEvaluationListResp
• DtoExecution
• DtoExecutionRecord
• DtoGenericResponseAny
• DtoGenericResponseDtoAlgorithmListResp
• DtoGenericResponseDtoDatasetDeleteResp
• DtoGenericResponseDtoEvaluationListResp
• DtoGenericResponseDtoPaginationRespDtoDatasetItem
• DtoGenericResponseDtoPaginationRespDtoInjectionItem
• DtoGenericResponseDtoPaginationRespDtoTaskItem
• DtoGenericResponseDtoPaginationRespDtoUnifiedTask
• DtoGenericResponseDtoQueryDatasetResp
• DtoGenericResponseDtoSubmitResp
• DtoGenericResponseDtoTaskDetailResp
• DtoGranularityRecord
• DtoInjectionItem
• DtoInjectionSubmitReq
• DtoPaginationRespDtoDatasetItem
• DtoPaginationRespDtoInjectionItem
• DtoPaginationRespDtoTaskItem
• DtoPaginationRespDtoUnifiedTask
• DtoQueryDatasetResp
• DtoRetryPolicy
• DtoSubmitResp
• DtoTaskDetailResp
• DtoTaskItem
• DtoTrace
• DtoUnifiedTask

Documentation For Authorization

Endpoints do not require authorization.

Author

[e-mail]