生成性能报告 - 云平台 OCP V4.3.0

生成性能报告

更新时间：2026-04-14 11:55:54

编辑

功能说明

生成集群的性能报告。

调用说明

接口约束

调用者需要具备指定集群的读写权限。

请求路径

post /api/v2/ob/clusters/{id}/performance/workload/reports

请求参数

参数	类型	必选	示例值	描述
id	Integer	是	1	目标 OceanBase 集群的 ID。
startSnapshotId	Long	是	123	报告的起始快照点。
endSnapshotId	Long	是	125	报告的结束快照点。
name	String	是	report_name	报告的名字。

返回结果

基础数据结构

参数	类型	说明
data	Object
├─ id	Long	报告的唯一ID。
├─ clusterName	String	报告所属集群的集群名。
├─ obClusterId	Long	报告所属集群的集群 ID。
├─ clusterId	Long	OCP 端记录的集群 ID。
├─ name	String	报告名称。
├─ beginReportTime	String	报告的起始时间。
├─ endReportTime	String	报告的结束时间。
├─ generateTime	String	报告生成时间。
├─ status	String	报告状态，分为三种：CREATING/SUCCESSFUL/FAILED。
├─ taskInstanceId	Long	关联的任务实例 ID。
├─ scope	String	报告的范围，分为两个级别：集群级别和租户级别。目前只支持集群级别的报告。
├─ creator	String	操作人。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的应用服务的地址。

示例

请求示例

post  /api/v2/ob/clusters/1/performance/workload/reports

返回示例

{
	"data": {
		"beginReportTime": "2023-01-12T06:01:00.026Z",
		"clusterId": 4,
		"clusterName": "odc_meta1",
		"creator": "admin",
		"endReportTime": "2023-01-12T08:01:00.935Z",
		"generateTime": "2023-01-12T19:44:41.725+08:00",
		"id": 16,
		"name": "OBAWR_odc_meta1_100005_202301121401_202301121601",
		"obClusterId": 100005,
		"scope": "CLUSTER",
		"status": "CREATING",
		"taskInstanceId": 2423941
	},
	"duration": 27,
	"server": "11.124.5.59",
	"status": 200,
	"successful": true,
	"timestamp": "2023-01-12T19:44:41.739+08:00",
	"traceId": "547b73e3e435415a"
}