跳转到内容

执行

用户执行API - 终端用户场景/脚本执行及结果访问


通过脚本内容创建执行

POST
/api/v1/exec/bycontent

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

开始执行

POST
/api/v1/exec/start

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

替换执行脚本配置

PUT
/api/v1/exec/{id}/script/config

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

查询执行详情

GET
/api/v1/exec/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

响应

成功

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

停止执行

POST
/api/v1/exec/stop

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

根据脚本ID创建执行

POST
/api/v1/exec/byscript

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

查询执行列表

GET
/api/v1/exec

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

projectId*

项目ID

类型integer
必填
format"int64"
id
类型integer
format"int64"
name
类型string
plugin
类型string
status
类型string
枚举
"CREATED""PENDING""RUNNING""STOPPED""FAILED""COMPLETED""TIMEOUT"
scriptId
类型integer
format"int64"
scriptType
类型string
枚举
"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"
scriptSource
类型string
枚举
"USER_DEFINED""IMPORTED""SERVICE_SMOKE""SERVICE_SECURITY""API""SCENARIO""GENERATE_DATA"
scriptSourceId
类型integer
format"int64"
priority
类型integer
format"int32"
maximum9223372036854776000
minimum0
nodeId
类型integer
format"int64"
startMode
类型string
枚举
"IMMEDIATELY""TIMING"
startDate
类型string
format"date-time"
actualStartDate
类型string
format"date-time"
endDate
类型string
format"date-time"
execBy
类型integer
format"int64"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

删除执行记录

DELETE
/api/v1/exec

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
[
0
]

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

通过脚本参数创建执行

POST
/api/v1/exec/byargs

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

全文搜索执行列表

GET
/api/v1/exec/search
UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

查询参数

projectId*

项目ID

类型integer
必填
format"int64"
id
类型integer
format"int64"
name
类型string
plugin
类型string
status
类型string
枚举
"CREATED""PENDING""RUNNING""STOPPED""FAILED""COMPLETED""TIMEOUT"
scriptId
类型integer
format"int64"
scriptType
类型string
枚举
"TEST_FUNCTIONALITY""TEST_PERFORMANCE""TEST_STABILITY""TEST_CUSTOMIZATION""MOCK_DATA""MOCK_APIS"
scriptSource
类型string
枚举
"USER_DEFINED""IMPORTED""SERVICE_SMOKE""SERVICE_SECURITY""API""SCENARIO""GENERATE_DATA"
scriptSourceId
类型integer
format"int64"
priority
类型integer
format"int32"
maximum9223372036854776000
minimum0
nodeId
类型integer
format"int64"
startMode
类型string
枚举
"IMMEDIATELY""TIMING"
startDate
类型string
format"date-time"
actualStartDate
类型string
format"date-time"
endDate
类型string
format"date-time"
execBy
类型integer
format"int64"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型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

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

查询执行的所有测试服务器配置,仅支持Http插件

GET
/api/v1/exec/{id}/test/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询实际执行的脚本

GET
/api/v1/exec/{id}/script

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询执行的基本信息

GET
/api/v1/exec/{id}/info

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换执行配置

PUT
/api/v1/exec/{id}/config

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

执行ID

类型integer
必填
format"int64"

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
变量
主体

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布