This topic describes how to obtain the details of an inspection report by using an API.
Callout
If a password is set, you must pass the authentication. For more information, see API hybrid encryption.
Request path
GET /api/v1/obcluster/inspection/report/:id
Request parameters
Parameter |
Type |
Required |
Example value |
Description |
|---|---|---|---|---|
| id | string | Yes | 1 | The ID of the inspection report. This parameter is specified in the path. |
Response
Parameter |
Type |
Description |
|---|---|---|
| successful | bool | Indicates whether the request was successful. |
| timestamp | time.Time | The timestamp when the server completed the request. |
| duration | int | The time taken by the server to process the request, in milliseconds. |
| status | int | The HTTP status code. |
| traceId | string | The trace ID of the request. |
| data | InspectionReport | The details of the inspection report. For more information, see the Data structure of InspectionReport section below. |
| error | ApiError | The error information, which contains the following fields:
|
Data structure of InspectionReport:
Parameter |
Type |
Description |
|---|---|---|
| id | int | The ID of the inspection report. |
| scenario | string | The inspection scenario, such as basic or performance. |
| critical_count | int | The number of critical issues. |
| failed_count | int | The number of failed items. |
| warning_count | int | The number of warning items. |
| pass_count | int | The number of passed items. |
| start_time | time.Time | The start time. |
| finish_time | time.Time | The end time. |
| local_task_id | string | The ID of the local task. |
| status | string | The status. |
| error_message | string | The error message. |
| result_detail | ResultDetail | The details of the inspection result. For more information, see the Data structure of ResultDetail section below. |
Data structure of ResultDetail:
Parameter |
Type |
Description |
|---|---|---|
| critical_items | []InspectionItem | The list of critical issues. For more information, see the Data structure of InspectionItem section below. |
| warning_items | []InspectionItem | The list of warning items. For more information, see the Data structure of InspectionItem section below. |
| failed_items | []InspectionItem | The list of failed items. For more information, see the Data structure of InspectionItem section below. |
| pass_items | []InspectionItem | The list of passed items. For more information, see the Data structure of InspectionItem section below. |
Data structure of InspectionItem:
Parameter |
Type |
Description |
|---|---|---|
| name | string | The name of the inspection item. |
| results | []string | The list of inspection results. |
Examples
Request example
GET 10.10.10.1:2886/api/v1/obcluster/inspection/report/1
Response example
{
"successful": true,
"timestamp": "2025-12-22T20:20:38.048216738+08:00",
"duration": 16,
"status": 200,
"traceId": "bb4c703bce7cd694",
"data": {
"scenario": "BASIC",
"critical_count": 3,
"failed_count": 0,
"warning_count": 0,
"pass_count": 52,
"start_time": "2025-12-22T16:39:06.005+08:00",
"finish_time": "2025-12-22T16:39:13.252+08:00",
"local_task_id": "20101509477090883",
"status": "SUCCEED",
"result_detail": {
"critical_items": [
{
"name": "cluster.observer_not_active",
"results": [
"[critical] [cluster:cluster] There is 10.10.10.1 not_ACTIVE observer, please check as soon as possible. "
]
},
{
"name": "tenant.tenant_min_resource",
"results": [
"[critical] [cluster:cluster] there tenant resource pool configuration is less than 2C4G, please check it. tenant_id: 1 "
]
},
{
"name": "cluster.data_path_settings",
"results": [
"[critical] ip:10.10.10.1, data_dir and log_dir_disk are on the same disk."
]
}
],
"pass_items": [
{
"name": "cluster.datafile_next",
"results": [
"all pass"
]
},
{
"name": "cluster.ob_enable_plan_cache_bad_version",
"results": [
"all pass"
]
},
{
"name": "cluster.upgrade_finished",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4000",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4015",
"results": [
"all pass"
]
},
{
"name": "cluster.memory_limit_percentage",
"results": [
"all pass"
]
},
{
"name": "cluster.tenant_locks",
"results": [
"all pass"
]
},
{
"name": "cluster.zone_not_active",
"results": [
"all pass"
]
},
{
"name": "log.log_size",
"results": [
"all pass"
]
},
{
"name": "cluster.logons_check",
"results": [
"all pass"
]
},
{
"name": "cluster.part_trans_action_max",
"results": [
"all pass"
]
},
{
"name": "cluster.tenant_number",
"results": [
"all pass"
]
},
{
"name": "cluster.deadlocks",
"results": [
"all pass"
]
},
{
"name": "disk.disk_full",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4016",
"results": [
"all pass"
]
},
{
"name": "ls.paxo_members",
"results": [
"all pass"
]
},
{
"name": "disk.clog_abnormal_file",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4105",
"results": [
"all pass"
]
},
{
"name": "log.log_size_with_ocp",
"results": [
"all pass"
]
},
{
"name": "tenant.writing_throttling_trigger_percentage",
"results": [
"all pass"
]
},
{
"name": "cluster.table_history_too_many",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4108",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4103",
"results": [
"all pass"
]
},
{
"name": "cluster.auto_increment_cache_size",
"results": [
"all pass"
]
},
{
"name": "cluster.freeze_trigger_percentage",
"results": [
"all pass"
]
},
{
"name": "cluster.global_indexes_too_much",
"results": [
"all pass"
]
},
{
"name": "cluster.major",
"results": [
"all pass"
]
},
{
"name": "cluster.major_suspended",
"results": [
"all pass"
]
},
{
"name": "cluster.memory_chunk_cache_size",
"results": [
"all pass"
]
},
{
"name": "clog.clog_disk_full",
"results": [
"all pass"
]
},
{
"name": "cluster.optimizer_better_inlist_costing_parmmeter",
"results": [
"all pass"
]
},
{
"name": "cluster.resource_limit_max_session_num",
"results": [
"all pass"
]
},
{
"name": "disk.sstable_abnormal_file",
"results": [
"all pass"
]
},
{
"name": "cluster.core_file_find",
"results": [
"all pass"
]
},
{
"name": "cluster.sys_log_level",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4001",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4012",
"results": [
"all pass"
]
},
{
"name": "cluster.ls_number",
"results": [
"all pass"
]
},
{
"name": "disk.data_disk_full",
"results": [
"all pass"
]
},
{
"name": "disk.disk_hole",
"results": [
"all pass"
]
},
{
"name": "cluster.sys_obcon_health",
"results": [
"all pass"
]
},
{
"name": "clog.clog_hang",
"results": [
"all pass"
]
},
{
"name": "cluster.mod_too_large",
"results": [
"all pass"
]
},
{
"name": "cluster.session_limit",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4377",
"results": [
"all pass"
]
},
{
"name": "cluster.memstore_limit_percentage",
"results": [
"all pass"
]
},
{
"name": "cluster.no_leader",
"results": [
"all pass"
]
},
{
"name": "cluster.task_opt_stat_gather_fail",
"results": [
"all pass"
]
},
{
"name": "cluster.upper_trans_version",
"results": [
"all pass"
]
},
{
"name": "table.information_schema_tables_two_data",
"results": [
"all pass"
]
},
{
"name": "cluster.server_permanent_offline_time",
"results": [
"all pass"
]
},
{
"name": "err_code.find_err_4013",
"results": [
"all pass"
]
}
]
}
}
}