Indicator - PerformanceTest

Performance Test Indicator Management - Define and adjust performance test parameters (concurrency levels, TPS targets, error rate thresholds)

---

Query the indicator list of performance

GET

/api/v1/indicator/perf

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

targetType*

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT""API,SCENARIO"

admin

Required when app administrators query all performance indicator

类型boolean

targetName

Target name

类型string

createdBy

Performance indicator creator id

类型integer

format"int64"

createdDate

Performance indicator creation time

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/perf

试验场

授权

UserHttpBearer

变量

键

值

targetType*

admin

targetName

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---

Replace the indicator of performance

PUT

/api/v1/indicator/perf

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"targetId": 0,

"targetType": "string",

"threads": 0,

"duration": {

"value": 0,

"unit": "string"

},

"rampUpThreads": 0,

"rampUpInterval": {

"value": 0,

"unit": "string"

},

"art": 0,

"percentile": "string",

"tps": 0,

"errorRate": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

PUT

/api/v1/indicator/perf

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Add the indicator of performance

POST

/api/v1/indicator/perf

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体

application/json

{

"targetId": 0,

"targetType": "string",

"threads": 0,

"duration": {

"value": 0,

"unit": "string"

},

"rampUpThreads": 0,

"rampUpInterval": {

"value": 0,

"unit": "string"

},

"art": 0,

"percentile": "string",

"tps": 0,

"errorRate": 0

}

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

POST

/api/v1/indicator/perf

试验场

授权

UserHttpBearer

主体

示例

cURL

JavaScript

PHP

Python

---

Query the indicator detail of performance

GET

/api/v1/indicator/{targetType}/{targetId}/perf

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API,SCENARIO

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/{targetType}/{targetId}/perf

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Delete the performance indicator of target

DELETE

/api/v1/indicator/{targetType}/{targetId}/perf

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API,SCENARIO

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

DELETE

/api/v1/indicator/{targetType}/{targetId}/perf

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Query the indicator detail of performance

GET

/api/v1/indicator/{targetType}/{targetId}/perf/detailOrDefault

Note: Return to default configuration when not set

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

路径参数

targetType*

Target Type, allowable values: API,SCENARIO

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"

targetId*

Target id

类型integer

必填

format"int64"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/{targetType}/{targetId}/perf/detailOrDefault

试验场

授权

UserHttpBearer

变量

键

值

targetType*

targetId*

示例

cURL

JavaScript

PHP

Python

---

Fulltext search the indicator of performance

GET

/api/v1/indicator/perf/search

授权

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数

查询参数

id

Perf indicator id

类型integer

format"int64"

targetType*

类型string

必填

枚举

"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT""API,SCENARIO"

admin

Required when app administrators query all performance indicator

类型boolean

targetName

Target name

类型string

createdBy

Performance indicator creator id

类型integer

format"int64"

createdDate

Performance indicator creation time

类型string

format"date-time"

pageNo

Page data size, default 1, maximum 100000

类型integer

format"int32"

maximum100000

minimum1

pageSize

Page data size, default 10, maximum 2000

类型integer

format"int32"

maximum2000

minimum1

orderBy

Sort field

类型string

orderSort

Sorting method

类型string

枚举

"ASC""DESC"

filters[0].key

Filter field name

类型string

filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[0].value

Filter value

filters[1].key

Filter field name

类型string

filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[1].value

Filter value

filters[2].key

Filter field name

类型string

filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型string

枚举

"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"

filters[2].value

Filter value

infoScope

Query information scope

类型string

枚举

"BASIC""DETAIL"

响应

OK

Content-Type

*/*

{

"code": "string",

"msg": "string",

"data": {

},

"datetime": "string",

"ext": {

"additionalProperties": {

}

}

}

GET

/api/v1/indicator/perf/search

试验场

授权

UserHttpBearer

变量

键

值

id

targetType*

admin

targetName

createdBy

createdDate

pageNo

pageSize

orderBy

orderSort

filters[0].key

filters[0].op

filters[0].value

filters[1].key

filters[1].op

filters[1].value

filters[2].key

filters[2].op

filters[2].value

infoScope

示例

cURL

JavaScript

PHP

Python

---