文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 分页获取工程关键字详细信息列表（含目录） - ListBasicAwInfoListSupportsSearch
更新时间：2026-07-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

分页获取工程关键字详细信息列表（含目录） - ListBasicAwInfoListSupportsSearch

功能介绍

根据工程唯一标识分页获取工程关键字列表（含目录）

调用方法

请参见如何调用API。

URI

POST /v4/{project_id}/aw-cata/aw-info-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

page_no

是

String

参数解释

当前页数

约束限制

不涉及

取值范围

0-999999999

默认取值

不涉及

page_size

是

String

参数解释

每页的记录数

约束限制

不涉及

取值范围

0-100

默认取值

不涉及

parent_id

否

String

参数解释

父目录唯一标识

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

获取方法

查看目录下关键字，从接口POST /v4/{project_id}/aw-cata/aw-info-list的请求参数获取parent_id对应的值

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。
表4 请求Body参数

参数

是否必选

参数类型

描述

search_type

否

String

参数解释

过滤类型

取值范围

不涉及

search_value

否

String

参数解释

过滤条件

取值范围

不涉及

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

error

CommonResponseErrorPageResultBasicAWInfo object

参数解释

统一错误返回

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串

result

PageResultBasicAWInfo object

参数解释

结果

取值范围

不涉及

status

String

参数解释

'状态值，如success、error'

取值范围

  • success，请求成功

  • error，请求报错
表6 CommonResponseErrorPageResultBasicAWInfo

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

不超过256个字符组成的字符串

detail

PageResultBasicAWInfo object

参数解释

错误信息详情

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

不超过1000个字符组成的字符串
表7 PageResultBasicAWInfo

参数

参数类型

描述

page_list

Array of BasicAWInfo objects

参数解释

当前页数据

取值范围

不涉及

page_no

Integer

参数解释

当前页数

约束限制

不涉及

取值范围

0-999999999

默认取值

不涉及

page_size

Integer

参数解释

每页条数

约束限制

不涉及

取值范围

0-100

默认取值

不涉及

total_page

Integer

参数解释

总页数

取值范围

0-999999999

total_size

Long

参数解释

数据总条数

取值范围

0-999999999
表8 BasicAWInfo

参数

参数类型

描述

aw_code

String

参数解释

关键字代码, hasCode为1时有效

取值范围

不涉及

aw_description

String

参数解释

模板描述

取值范围

不超过500个字符组成的字符串

aw_ins_list

Array of AwInstanceRes objects

参数解释

组合关键字包含的关键字实例信息，关键字类型为2时该字段有效

aw_mark

Integer

参数解释

关键字标记

取值范围

  • 0,normal

  • 1,new

  • 2,update

  • 3,delete

aw_operationid

String

参数解释

接口的唯一标识

取值范围

不超过300个字符组成的字符串

aw_tags

String

参数解释

接口的标签

取值范围

不超过300个字符组成的字符串

aw_type

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

aw_uniqueid

String

参数解释

关键字唯一标识和关键字标签的拼接

取值范围

不超过600个字符组成的字符串

by_order

Integer

参数解释

顺序

取值范围

0-9999

cata_type

Integer

参数解释

目录层级

取值范围

  • 1,title

  • 2,tags

  • 3,customize

  • 4,default folder

  • 7,combined aw folder

child_list

Array of BasicAWInfo objects

参数解释

新增childList以支持嵌套层级结构

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

create_user_id

String

参数解释

创建者唯一标识

取值范围

32个字符组成的字符串

custom_aw_libs

Array of UploadFileRes objects

参数解释

自定义关键字的依赖包

delete_time

String

参数解释

删除时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

delete_user

String

参数解释

删除者

取值范围

32个字符组成的字符串

description

String

参数解释

描述

dft_check_point_list

Array of CheckPoint objects

参数解释

默认检查点集合

dft_custom_header

Array of AwParam objects

参数解释

默认请求头参数对象

dft_retry_interval

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

dft_retry_times

String

参数解释

重试次数

取值范围

自然数

dft_variable_list

Array of AwVariable objects

参数解释

默认变量信息集合

extra_info

Object

参数解释

补充信息

group_name

String

参数解释

分组名

取值范围

不超过50个字符组成的字符串

has_code

Integer

参数解释

是否自带代码

取值范围

  • 0,不自带代码，该关键字依赖source字段中的源码

  • 1，自带代码

id

String

参数解释

关键字唯一标识

取值范围

32个字符组成的字符串

import_package

Array of strings

参数解释

导入的包

interface_label

String

参数解释

接口的x-extend

取值范围

不超过300个字符组成的字符串

is_favorite

Integer

参数解释

是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断

取值范围

  • 0,未收藏

  • 1,已收藏

is_folder

String

参数解释

判断是否为文件夹的标识

取值范围

  • 0,文件

  • 1,文件夹

keyword_variable_value

Array of AwVariable objects

参数解释

关键字局部变量

method

String

参数解释

方法

取值范围

不超过300个字符组成的字符串

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nameView

String

参数解释

在页面上显示的名字

取值范围

不超过300个字符组成的字符串

origin_project

String

参数解释

源工程信息，如该关键字是从其他工程过来的(继承或者copy to local)

取值范围

32个字符组成的字符串

output_param_list

Array of AwVariable objects

参数解释

组合关键字的输出参数信息，该字段不存数据库，实时获取

page_no

Integer

参数解释

当前页数

约束限制

不涉及

取值范围

0-999999999

默认取值

不涉及

page_size

Integer

参数解释

每页条数

约束限制

不涉及

取值范围

0-100

默认取值

不涉及

param_type_and_dft_value

Array of AwParam objects

参数解释

参数类型和参数默认值对应List

parent_id

String

参数解释

关键字目录父编号

取值范围

32个字符组成的字符串

project_id

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

protocol_type

String

参数解释

协议类型

取值范围

  • http/https

  • dsf

  • other

public_aw_lib

PublicAwLibRes object

参数解释

公共关键字信息

public_aw_lib_id

String

参数解释

所属公共关键字库唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

return_type

String

参数解释

返回类型

取值范围

不涉及

root_id

String

参数解释

root唯一标识

取值范围

32个字符组成的字符串

source

String

参数解释

来源

取值范围

不涉及

special_type

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

tmssCaseNumber

String

参数解释

关键字管理的用例编号

取值范围

不涉及

tmss_case_id

String

参数解释

关键字管理的用例唯一标识

取值范围

不超过32个字符组成的字符串

total_page

Integer

参数解释

总页数

取值范围

0-999999999

total_size

Integer

参数解释

总条数

取值范围

0-999999999

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

warningMsg

String

参数解释

警告信息

取值范围

不涉及

yamlName

String

参数解释

所属yaml文件名称,该字段不存库，用来记录从哪个yaml文件导入

取值范围

不涉及
表9 AwInstanceRes

参数

参数类型

描述

alias_runaw

String

参数解释

关键字内容描述字段

取值范围

不超过100个字符组成的字符串

authentication_info

AuthInfo object

参数解释

认证信息

authentication_type

String

参数解释

认证类型

取值范围

  • 0,无认证

  • 1,aksk认证

aw_description

String

参数解释

脚本模板描述信息，在用例更新时添加

取值范围

不超过500个字符组成的字符串

aw_id

String

参数解释

关键字唯一标识

取值范围

32个字符组成的字符串

aw_type

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

basic_aw

BasicAwRes object

参数解释

关键字

body_param_type

String

参数解释

关键字实例的参数body体类型

取值范围

  • form

  • text

by_order

Integer

参数解释

顺序

取值范围

0-9999

changeSign

Integer

参数解释

变化标志

取值范围

  • 0,没有变更

  • 1,发生变更

check_point_list

Array of CheckPoint objects

参数解释

检查点集合

children

Array of AwInstanceRes objects

参数解释

关键字实例

condition_statement

String

参数解释

条件语句

取值范围

不涉及

condition_type

Integer

参数解释

条件类型

取值范围

  • 0,not condition

  • 1,if begin

  • 2,if

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

custom_header

Array of AwParam objects

参数解释

测试步骤自定义请求头List；后续自定义URL请求头不再使用该字段

description

String

描述

error_info

ErrorInfo object

参数解释

执行的错误日志内容列表

extra_info

ExtraInfo object

参数解释

补充信息

from_outside

Integer

参数解释

该关键字是否来自外部工程

取值范围

  • 0,no

  • 1,yes

hasLevel

Integer

参数解释

层级

header_array

Object

参数解释

请求头列表

取值范围

不涉及

his_script

String

参数解释

值不为null表示老的IF判断语句；值为null表示新的IF判断语句

取值范围

  • null,新的IF判断语句

  • 不为null,老的IF判断语句

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

is_basic

Integer

是否模板类型测试步骤 0：自定义URL配置类型；1：模板类型测试步骤

is_contract_aw

Integer

是否是契约关键字 0-否；1-yes

is_disabled

Integer

是否被禁用 0-否；1-yes

is_sectest_aw

Integer

是否是安全测试关键字

level

Integer

用例级别

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

param_dependent

String

参数解释

参数依赖

取值范围

不涉及

param_dependent_enabled

Integer

是否启用参数依赖

param_type_and_value

Array of AwParam objects

参数类型和参数值对应集合

projectId

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

relation

String

参数解释

关键字唯一标识层级关系

取值范围

不超过512个字符组成的字符串

relation_id

String

参数解释

层级关系唯一标识

取值范围

32个字符组成的字符串

relation_type

Integer

参数解释

映射类型

取值范围

  • 1,反向删除映射

  • 2,用例自动添加的方向删除步骤

retry_interval

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

retry_times

String

参数解释

重试次数

取值范围

自然数

scriptName

String

参数解释

获取脚本生成时，要使用的步骤名称

取值范围

1-128个字符

service_and_stage

String

参数解释

关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效

取值范围

不涉及

special_type

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

user_id

String

参数解释

用户唯一标识

取值范围

32个字符组成的字符串

variable_list

Array of AwVariable objects

定义的变量信息
表10 BasicAwRes

参数

参数类型

描述

aw_code

String

参数解释

关键字代码, hasCode为1时有效

取值范围

不涉及

aw_description

String

参数解释

关键字描述

取值范围

不超过500个字符组成的字符串

aw_mark

Integer

参数解释

关键字标记

取值范围

  • 0,normal

  • 1,new

  • 2,update

  • 3,delete

aw_operationid

String

参数解释

关键字操作编号

取值范围

不超过300个字符组成的字符串

aw_tags

String

参数解释

关键字标签

取值范围

不超过300个字符组成的字符串

aw_type

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

aw_uniqueid

String

参数解释

关键字来源

取值范围

不超过600个字符组成的字符串

by_order

Integer

参数解释

关键字顺序

取值范围

0-9999

create_time

String

参数解释

关键字创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

关键字创建者

取值范围

不超过255个字符组成的字符串

create_user_id

String

参数解释

关键字创建者ID

取值范围

32个字符组成的字符串

delete_time

String

参数解释

删除时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

delete_user

String

参数解释

关键字删除者

取值范围

32个字符组成的字符串

description

String

参数解释

关键字描述

取值范围

不涉及

dft_check_point_list

Array of objects

参数解释

默认检查点列表

dft_custom_header

Array of objects

参数解释

默认请求头参数对象

dft_retry_interval

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

dft_retry_times

String

参数解释

重试次数

取值范围

自然数

keyword_variable_value

Array of AwVariable objects

参数解释

变量值

dft_variable_list

Array of objects

参数解释

默认变量信息列表

aw_ins_list

Array of AwInstance objects

组合关键字包含的关键字实例信息，关键字类型为2时该字段有效

output_param_list

Array of AwVariable objects

参数解释

组合关键字的输出参数信息，该字段不存数据库，实时获取

custom_aw_libs

Array of UploadFile objects

参数解释

关键字库的文件列表

extra_info

Object

参数解释

补充信息

group_name

String

参数解释

分组名

取值范围

不超过50个字符组成的字符串

has_code

Integer

参数解释

是否存在代码

取值范围*

  • 0,不存在代码

  • 1,存在代码

id

String

参数解释

关键字编号

取值范围

32个字符组成的字符串

import_package

Array of strings

参数解释

导入的包名

interface_label

String

参数解释

接口的x-extend字段说明

取值范围

不超过300个字符组成的字符串

is_favorite

Integer

参数解释

是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断

取值范围

  • 0,未收藏

  • 1,已收藏

method

String

参数解释

关键字方法名

取值范围

不超过300个字符组成的字符串

name

String

参数解释

关键字名

取值范围

不超过300个字符组成的字符串

nameView

String

参数解释

在页面上显示的名字

取值范围

不超过300个字符组成的字符串

origin_project

String

参数解释

源工程信息

取值范围

32个字符组成的字符串

param_type_and_dft_value

Array of objects

参数解释

参数类型和参数默认值

project_id

String

参数解释

工程编号

取值范围

32个字符组成的字符串

protocol_type

String

参数解释

协议类型

取值范围

  • http/https

  • dsf

  • other

public_aw_lib

Object

参数解释

公共关键字信息

取值范围

32个字符组成的字符串

public_aw_lib_id

String

参数解释

公共关键字唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

region信息

取值范围

不超过32个字符组成的字符串

return_type

String

参数解释

返回值类型

取值范围

不涉及

root_id

String

参数解释

根节点编号

取值范围

32个字符组成的字符串

source

String

参数解释

关键字依赖的类源

取值范围

不涉及

special_type

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

tmssCaseNumber

String

参数解释

关键字编号（来自测试管理服务）

取值范围

不涉及

tmss_case_id

String

参数解释

测试用例唯一标识

取值范围

不超过32个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

warningMsg

String

参数解释

警告信息

取值范围

不涉及

yamlName

String

参数解释

yaml名称

取值范围

不涉及
表11 AwInstance

参数

参数类型

描述

alias_runaw

String

参数解释

关键字内容描述字段

取值范围

不超过100个字符组成的字符串

authentication_info

AuthInfo object

参数解释

认证信息

authentication_type

String

参数解释

认证类型

取值范围

  • 0,无认证

  • 1,aksk认证

aw_description

String

参数解释

脚本模板描述信息，在用例更新时添加

取值范围

不超过500个字符组成的字符串

aw_id

String

参数解释

关键字唯一标识

取值范围

32个字符组成的字符串

aw_type

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

basic_aw

BasicAw object

参数解释

关键字

body_param_type

String

参数解释

关键字实例的参数body体类型

取值范围

  • form

  • text

by_order

Integer

参数解释

顺序

取值范围

0-9999

changeSign

Integer

参数解释

变化标志

取值范围

  • 0,没有变更

  • 1,发生变更

check_point_list

Array of CheckPoint objects

参数解释

检查点集合

children

Array of AwInstance objects

参数解释

关键字实例

condition_statement

String

参数解释

条件语句

取值范围

不涉及

condition_type

Integer

参数解释

条件类型

取值范围

  • 0,not condition

  • 1,if begin

  • 2,if

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

custom_header

Array of AwParam objects

参数解释

测试步骤自定义请求头集合；后续自定义URL请求头不再使用该字段

description

String

描述

error_info

ErrorInfo object

参数解释

执行的错误日志内容列表

extra_info

ExtraInfo object

参数解释

补充信息

from_outside

Integer

参数解释

该关键字是否来自外部工程

取值范围

  • 0,no

  • 1,yes

hasLevel

Integer

参数解释

层级

header_array

Object

参数解释

请求头列表

取值范围

不涉及

his_script

String

参数解释

值不为null表示老的IF判断语句；值为null表示新的IF判断语句

取值范围

  • null,新的IF判断语句

  • 不为null,老的IF判断语句

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

is_basic

Integer

是否模板类型测试步骤 0：自定义URL配置类型；1：模板类型测试步骤

is_contract_aw

Integer

是否是契约关键字 0-否；1-yes

is_disabled

Integer

是否被禁用 0-否；1-yes

is_sectest_aw

Integer

是否是安全测试关键字

level

Integer

用例级别

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

param_dependent

String

参数解释

参数依赖

取值范围

不涉及

param_dependent_enabled

Integer

是否启用参数依赖

param_type_and_value

Array of AwParam objects

参数类型和参数值对应集合

projectId

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

relation

String

参数解释

关键字唯一标识层级关系

取值范围

不超过512个字符组成的字符串

relation_id

String

参数解释

层级关系唯一标识

取值范围

32个字符组成的字符串

relation_type

Integer

参数解释

映射类型

取值范围

  • 1,反向删除映射

  • 2,用例自动添加的方向删除步骤

retry_interval

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

retry_times

String

参数解释

重试次数

取值范围

自然数

scriptName

String

参数解释

获取脚本生成时，要使用的步骤名称

取值范围

1-128个字符

service_and_stage

String

参数解释

关键字所来自工程的服务名和阶段名 fromOutside为1时该值有效

取值范围

不涉及

special_type

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

user_id

String

参数解释

用户唯一标识

取值范围

32个字符组成的字符串

variable_list

Array of AwVariable objects

用例局部变量
表12 AuthInfo

参数

参数类型

描述

access_key

String

访问密钥

secret_key

String

私钥
表13 BasicAw

参数

参数类型

描述

aw_code

String

参数解释

关键字代码, hasCode为1时有效

取值范围

不涉及

aw_description

String

参数解释

脚本模板描述信息，在用例更新时添加

取值范围

不超过500个字符组成的字符串

aw_ins_list

Array of AwInstance objects

组合关键字包含的关键字实例信息，关键字类型为2时该字段有效

aw_mark

Integer

参数解释

关键字标记

取值范围

  • 0,normal

  • 1,new

  • 2,update

  • 3,delete

aw_operationid

String

参数解释

接口的唯一标识

取值范围

不超过300个字符组成的字符串

aw_tags

String

参数解释

接口的标签

取值范围

不超过300个字符组成的字符串

aw_type

Integer

参数解释

关键字类型

取值范围

  • 1,普通关键字

  • 2,组合关键字

  • 3,导入关键字

aw_uniqueid

String

参数解释

关键字唯一标识和关键字标签的拼接

取值范围

不超过600个字符组成的字符串

by_order

Integer

参数解释

顺序

取值范围

0-9999

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

create_user_id

String

参数解释

创建者唯一标识

取值范围

32个字符组成的字符串

custom_aw_libs

Array of UploadFile objects

参数解释

关键字库的文件列表

delete_time

String

参数解释

删除时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

delete_user

String

参数解释

删除者

取值范围

32个字符组成的字符串

description

String

描述

dft_check_point_list

Array of CheckPoint objects

参数解释

检查点集合

dft_custom_header

Array of AwParam objects

参数解释

默认请求头参数对象

dft_retry_interval

String

参数解释

重试间隔时间 (ms)， 为空表示不等待

取值范围

正整数或空

dft_retry_times

String

参数解释

重试次数

取值范围

自然数

dft_variable_list

Array of AwVariable objects

参数解释

定义的变量信息

extra_info

Object

补充信息

group_name

String

参数解释

分组名

取值范围

不超过50个字符组成的字符串

has_code

Integer

参数解释

是否自带代码

取值范围

  • 0,不自带代码，该关键字依赖source字段中的源码

  • 1，自带代码

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

import_package

Array of strings

参数解释

导入的包

interface_label

String

参数解释

接口的x-extend

取值范围

不超过300个字符组成的字符串

is_favorite

Integer

参数解释

是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断

取值范围

  • 0,未收藏

  • 1,已收藏

keyword_variable_value

Array of AwVariable objects

参数解释

关键字局部变量

method

String

参数解释

方法

取值范围

不超过300个字符组成的字符串

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nameView

String

参数解释

关键字在页面上显示的名字

取值范围

不超过300个字符组成的字符串

origin_project

String

参数解释

源工程信息，如该关键字是从其他工程过来的(继承或者copy to local)

取值范围

32个字符组成的字符串

output_param_list

Array of AwVariable objects

参数解释

组合关键字的输出参数信息，该字段不存数据库，实时获取

param_type_and_dft_value

Array of AwParam objects

参数解释

参数类型和参数默认值对应集合

project_id

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

protocol_type

String

参数解释

协议类型

取值范围

  • http/https

  • dsf

  • other

public_aw_lib

PublicAwLib object

公共关键字信息

public_aw_lib_id

String

所属公共关键字库唯一标识

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

return_type

String

参数解释

返回类型

取值范围

不涉及

root_id

String

参数解释

root唯一标识

取值范围

32个字符组成的字符串

source

String

来源

special_type

Integer

参数解释

特殊关键字类型

取值范围

  • 0,导入yaml生成模板aw

  • 1,导入yaml 生成用例区分

  • 9,公共AW

  • 10,导入yaml 生成模板header

  • 99,自定义url

  • 90,自定义url生成模板aw

  • 11,自定义AW

tmssCaseNumber

String

参数解释

关键字管理的用例编号

取值范围

不涉及

tmss_case_id

String

参数解释

关键字管理的用例唯一标识

取值范围

不超过32个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

warningMsg

String

参数解释

警告信息

取值范围

不涉及

yamlName

String

参数解释

所属yaml文件名称,该字段不存库，用来记录从哪个yaml文件导入

取值范围

不涉及
表14 PublicAwLib

参数

参数类型

描述

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

document_link

String

参数解释

文档链接

取值范围

不超过300个字符组成的字符串

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

net_area

Array of strings

参数解释

蓝区:Blue,绿区:Green,黄区:Yellow

取值范围

  • Blue

  • Green

  • Yellow

obs_temp_url

String

obs临时url

product_line

String

产品线

repo_branch

String

参数解释

仓库分支

取值范围

不超过50个字符组成的字符串

repo_lib_path

String

存公共关键字依赖jar包的目录

repo_password

String

参数解释

仓库密码

取值范围

不超过1000个字符组成的字符串

repo_private_key

String

参数解释

仓库密钥

取值范围

不超过3000个字符组成的字符串

repo_url

String

参数解释

仓库地址

取值范围

不超过300个字符组成的字符串

repo_username

String

参数解释

仓库用户名

取值范围

不超过50个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表15 UploadFile

参数

参数类型

描述

awInsId

String

参数解释

所属的关键字实例的唯一标识

取值范围

32个字符组成的字符串

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

current_size

Long

参数解释

当前大小

取值范围

自然数

filePath

String

参数解释

文件路径

取值范围

不涉及

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

originName

String

参数解释

文件的原名

取值范围

不超过300个字符组成的字符串

projectId

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

testcase_id

String

参数解释

测试用例的唯一标识符

取值范围

32个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表16 ErrorInfo

参数

参数类型

描述

error_content

String

参数解释

错误内容的描述

取值范围

不涉及

error_index

String

参数解释

错误索引的描述

取值范围

不涉及

error_point

String

参数解释

错误点的描述

取值范围

不涉及

high_light

Boolean

参数解释

是否高亮标识

取值范围

  • true

  • false
表17 ExtraInfo

参数

参数类型

描述

childImportPackage

Array of strings

参数解释

子级导入的包

取值范围

不涉及

document_link

String

参数解释

文档链接

取值范围

不超过300个字符组成的字符串

http_method

String

参数解释

http请求方法

取值范围

  • get

  • post

  • put

  • delete

http_url

String

参数解释

HTTP请求的URL

取值范围

不涉及

importPackage

Array of strings

参数解释

导入的包

取值范围

不涉及

mock

MockInfo object

参数解释

关键字实例中的mock信息

取值范围

不涉及

outputParam

Array of AwVariable objects

参数解释

输出参数

取值范围

不涉及

param_dependent

String

参数解释

参数依赖

取值范围

不涉及

summary

String

参数解释

摘要

取值范围

不涉及
表18 UploadFileRes

参数

参数类型

描述

awInsId

String

参数解释

所属的关键字实例的唯一标识

取值范围

32个字符组成的字符串

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

current_size

Long

参数解释

当前大小

取值范围

自然数

filePath

String

参数解释

文件路径

取值范围

不涉及

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

String

参数解释

文件在系统中的名字

取值范围

不超过300个字符组成的字符串

originName

String

参数解释

文件的原名

取值范围

不超过300个字符组成的字符串

projectId

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

不超过32个字符组成的字符串

testcase_id

String

参数解释

测试用例的唯一标识符

取值范围

32个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串
表19 CheckPoint

参数

参数类型

描述

comparison

String

参数解释

比较符

取值范围

不涉及

description

String

参数解释

描述信息

function_arg

String

参数解释

类型值

取值范围

不涉及

function_type

String

参数解释

高级提取类型

取值范围

  • REGEX,正则表达式

  • SUBSTRING, 字符串截取

property

String

参数解释

属性

取值范围

不涉及

value

String

参数解释

目标值
表20 AwVariable

参数

参数类型

描述

by_order

Integer

参数解释

节点顺序

取值范围

0-9999

currentPermission

String

参数解释

当前用户权限

取值范围

不涉及

description

String

参数解释

参数描述

dynamicParam

String

参数解释

动态参数名称

取值范围

不涉及

dynamicParamFlag

Boolean

参数解释

动态参数标志,默认为false. true代表动态参数; false代表非动态参数

functionParams

String

参数解释

变量参数（[]:空参、[a]:一参，[a,b]:两参）

取值范围

不涉及

function_arg

String

参数解释

提取类型的类型值

取值范围

不涉及

function_type

String

参数解释

高级提取类型，响应提取时要使用什么方法处理参数

取值范围

  • REGEX, 正则表达式

  • SUBSTRING, 字符串截取

isSensitiveInfo

Boolean

参数解释

是否是敏感字段

取值范围

  • true,

  • false

isSensitiveModified

Boolean

参数解释

敏感字段是否被修改，不敏感字段不关注此值

is_out_put

Boolean

参数解释

是否是组合关键字的输出参数，只有组合关键字下awInstance的关键字变量有该字段

name

String

参数解释

参数名称

取值范围

不超过300个字符组成的字符串

node_id

String

参数解释

节点唯一标识

取值范围

32个字符组成的字符串

node_type

Integer

参数解释

节点类型

取值范围

  • 0,变量节点

  • null,变量节点

  • 1,目录节点

oldName

String

参数解释

旧名称

取值范围

不涉及

parent_node_id

String

参数解释

父节点唯一标识

取值范围

32个字符组成的字符串

property

String

参数解释

属性

取值范围

不涉及

regex

String

参数解释

内置函数枚举

取值范围

不涉及

sensitiveInfoSetterTime

String

参数解释

敏感参数设置时间

取值范围

不涉及

sensitiveInfoSetterUser

String

参数解释

敏感参数设置者名称

取值范围

不涉及

type

String

参数解释

类型

取值范围

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

variableType

Integer

参数解释

变量类型（0：text，10-16：分别对应7个内置函数）

取值范围

  • 10,任意长度随机字符串

  • 11,指定范围随机int

  • 12,生成当前整数时间戳（从1970-01-01 00:00 UTC开始的秒数)

  • 13,按照指定的format格式化时间戳，如 $timestamp_format(timestamp, YYYY-MM-DD)

  • 14,生成UUID

  • 15,使用Base64方法编码参数

  • 16,使用指定参数生成MD5哈希值

  • 18,sha512编码参数
表21 AwParam

参数

参数类型

描述

basic_value

AwParamBasicValue object

参数解释

关键字参数基本类型取值类

取值范围

不涉及

basic_value_list

Array of AwParamBasicValue objects

参数解释

关键字参数, valueType为1时该值有效

取值范围

不涉及

custom_body

String

参数解释

自定义requestBody内容,inType为2且isBodyCustom为1时有效

取值范围

不涉及

defaultValue

String

参数解释

默认值

取值范围

不涉及

description

String

参数解释

关键字参数描述

取值范围

不超过3000个字符组成的字符串

disabled

Boolean

参数解释

是否禁用,只有非必需参数才能被禁用

取值范围

  • true

  • false

drop_down_value

String

参数解释

用于存储下拉菜单的值

取值范围

不涉及

enum_type

String

参数解释

枚举类型

取值范围

  • 0,基本类型

  • 1,基本类型数组

  • 2,结构体

  • 3,结构体数组

  • 5,枚举，下拉框展示

  • 6,枚举，单选框展示

  • 7,下拉框

  • 8,单选按钮

  • 9,公共的

enum_type_selected

String

参数解释

当前选中的枚举类型

取值范围

  • 0,基本类型

  • 1,基本类型数组

  • 2,结构体

  • 3,结构体数组

  • 5,枚举，下拉框展示

  • 6,枚举，单选框展示

  • 7,下拉框

  • 8,单选按钮

  • 9,公共的

format

String

参数解释

num和String有效

取值范围

不涉及

in_type

Integer

参数解释

rest接口输入参数类型

取值范围

  • 0,query

  • 1,path

  • 2,body

  • 3,header

  • 4,formdata

  • 5,config

isChecked

Boolean

参数解释

是否是被选中参数

取值范围

  • true

  • false

is_big_field

Boolean

参数解释

是否是大字段参数

取值范围

  • true

  • false

is_body_custom

Integer

参数解释

requestBody是否自定义，inType为2时有效。0-非自定义，用原有逻辑；1-自定义body,requestBody直接使用字段customBody

取值范围

  • 0,非自定义

  • 1,自定义body

is_contract_param

Integer

参数解释

是否是契约关键字

参数解释

  • 0, 否

  • 1, yes

is_sensitive

Boolean

参数解释

是否敏感参数

参数解释

  • 0,是

  • 1,不是

item

ItemParam object

参数解释

关键字基本参数

参数解释

不涉及

maxItems

Integer

参数解释

Array类型最大元素数

取值范围

不涉及

maxLength

Long

参数解释

String类型最大长度

取值范围

不涉及

maximum

Object

参数解释

Number类型最大值

取值范围

不涉及

minItems

Integer

参数解释

Array类型最小元素数

取值范围

不涉及

minLength

Long

参数解释

String类型最小长度

取值范围

不涉及

minimum

Object

参数解释

Number类型最小值

取值范围

不涉及

mock

MockInfo object

参数解释

关键字实例中的mock信息

取值范围

不涉及

name

String

参数解释

参数名

取值范围

不超过300个字符组成的字符串

object_value

Array of AwParam objects

参数解释

valueType为2时该值有效。valueType为3时，该值用来表示数组中单个结构体

取值范围

不涉及

object_value_list

Array<Array<AwParam>>

参数解释

valueType为3时该值有效

取值范围

不涉及

pattern

String

参数解释

num和String有效

取值范围

不涉及

required

Boolean

参数解释

是否必需参数

取值范围

  • true

  • false

type

String

参数解释

参数类型

取值范围

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

validate_rule

ValidateRule object

参数解释

校验规则

取值范围

不涉及

value_type

Integer

参数解释

参数值类型

取值范围

  • 0, 基本类型，type字段为String,Integer等基本类型

  • 1, type字段为List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br],List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]等基本类型List

  • 2, 结构体，type字段为除了基本类型以外的结构体

  • 3, 结构体数组，type字段为List<结构体>

  • 5, 枚举类型，TCP协议测试引入

xChoiceValue

String

参数解释

choice选择关系

取值范围

不涉及
表22 AwParamBasicValue

参数

参数类型

描述

value

String

参数解释

参数默认值，用例有效

value_range

String

参数解释

参数值范围，逻辑用例有效
表23 ItemParam

参数

参数类型

描述

basic_value

AwParamBasicValue object

参数解释

关键字参数基本类型取值类

defaultValue

String

参数解释

默认值

取值范围

不涉及

enum_type

String

参数解释

枚举类型

enum_type_selected

String

参数解释

当前选中的枚举类型

format

String

参数解释

num和String有效

is_big_field

Boolean

参数解释

是否是大字段参数

maxItems

Integer

参数解释

Array类型最大元素数

maxLength

Long

参数解释

String类型最大长度

maximum

Object

Number类型最大值

minItems

Integer

参数解释

Array类型最小元素数

minLength

Long

参数解释

String类型最小长度

minimum

Object

参数解释

Number类型最小值

pattern

String

参数解释

num和String有效

type

String

参数解释

参数类型

  • String

  • boolean

  • int

  • Integer

  • integer

  • float

  • short

  • double

  • long

  • BigDecimal

  • Object

  • ObjectNode

  • ArrayNode

  • file,file不是java的File类型，实际是String类型，传的文件路径

  • List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]

  • Json

  • JsonNode

validate_rule

ValidateRule object

参数解释

校验规则

value_type

Integer

参数解释

参数值类型

  • 0, 基本类型，type字段为String,Integer等基本类型

  • 1, type字段为List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br],List[/topic/body/section/table/tgroup/tbody/row/entry/ul/li/p/br {""}) (br]等基本类型List

  • 2, 结构体，type字段为除了基本类型以外的结构体

  • 3, 结构体数组，type字段为List<结构体>

  • 5, 枚举类型，TCP协议测试引入

xChoiceValue

String

参数解释

choice选择关系
表24 MockInfo

参数

参数类型

描述

mock_id

String

参数解释

mock唯一标识

取值范围

32个字符组成的字符串

mock_switch

Boolean

参数解释

mock开关

取值范围

  • true

  • false

mock_url

String

参数解释

mock地址

取值范围

不涉及
表25 ValidateRule

参数

参数类型

描述

dependent_info

Array of ConditionInstance objects

参数解释

依赖信息列表

取值范围

不涉及

enabled

Boolean

参数解释

是否启用的标识符

取值范围

  • true

  • false

is_configDep

Boolean

参数解释

配置依赖的标识符

取值范围

  • true

  • false

is_dependent

Boolean

参数解释

是否依赖的标识符

取值范围

  • true

  • false

message

String

参数解释

消息

取值范围

不涉及

result

String

参数解释

结果

取值范围

不涉及

special_char

String

参数解释

特殊字符

取值范围

不涉及

special_char_valid

String

参数解释

特殊字符的有效性

取值范围

不涉及

x_example

String

参数解释

示例

取值范围

不涉及
表26 ConditionInstance

参数

参数类型

描述

conditionIndex

Integer

参数解释

条件索引，用于标识当前处理的是哪个条件

conditionMap

Map<String,Array<String>>

参数解释

条件映射，键为整数，值为字符串列表，用于存储各个条件的信息

取值范围

不涉及

depParamMap

Map<String,DepParamInstance>

参数解释

依赖参数实例的映射

取值范围

不涉及

statementIndex

Integer

参数解释

声明索引，用于标识当前处理的是哪个声明
表27 DepParamInstance

参数

参数类型

描述

compareValue

String

参数解释

比较值

取值范围

不涉及

comparison

String

参数解释

比较符

取值范围

不涉及

condition

Boolean

参数解释

条件

inValidValues

Array of strings

参数解释

无效值列表

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

nullInfo

String

参数解释

空值信息

取值范围

不涉及

relationMap

Map<String,String>

参数解释

关系映射，key为整数，value为字符串

取值范围

不涉及

relationNum

Integer

参数解释

关系数量

取值范围

自然数

values

Array of strings

参数解释

值列表

取值范围

不涉及
表28 PublicAwLibRes

参数

参数类型

描述

create_time

String

参数解释

创建时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_time_stamp

Long

参数解释

创建时间戳(单位：毫秒)

取值范围

不涉及

create_time_string

String

参数解释

创建时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

不超过255个字符组成的字符串

document_link

String

参数解释

关联公共关键字时的编辑链接

取值范围

不超过300个字符组成的字符串

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

name

String

参数解释

名称

取值范围

不超过300个字符组成的字符串

net_area

Array of strings

参数解释

蓝区:Blue,绿区:Green,黄区:Yellow

取值范围

  • Blue

  • Green

  • Yellow

obs_temp_url

String

obs临时url

product_line

String

产品线

repo_branch

String

参数解释

仓库分支

取值范围

不超过50个字符组成的字符串

repo_lib_path

String

存公共关键字依赖jar包的目录

repo_password

String

参数解释

仓库密码

取值范围

不超过1000个字符组成的字符串

repo_private_key

String

参数解释

仓库密钥

取值范围

不超过3000个字符组成的字符串

repo_url

String

参数解释

仓库地址

取值范围

不超过300个字符组成的字符串

repo_username

String

参数解释

仓库用户名

取值范围

不超过50个字符组成的字符串

update_time

String

参数解释

更新时间(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_time_stamp

Long

参数解释

更新时间戳(单位：毫秒)

取值范围

不涉及

update_time_string

String

参数解释

更新时间字符串(格式：yyyy-MM-dd HH:mm:ss)

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

不超过32个字符组成的字符串

状态码：201

Created

状态码：401

表29 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：403

表30 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码：404

表31 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

post https://{endpoint}/v4/09645c1f3f954a8d9ab29174857cffc5/aw-cata/aw-info-list?page_no=1&page_size=10

{
  "search_type" : "",
  "search_value" : ""
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "page_no" : 1,
    "page_size" : 10,
    "total_page" : 1,
    "total_size" : 1,
    "page_list" : [ {
      "id" : "dfaba6a51f024c1f95229c1059ca34e0",
      "warningMsg" : null,
      "source" : "",
      "method" : "",
      "description" : null,
      "nameView" : null,
      "tmssCaseNumber" : null,
      "region" : null,
      "yamlName" : null,
      "create_time_string" : "2024-04-11 19:48:13 GMT+08:00",
      "update_time_string" : "2024-04-11 19:48:13 GMT+08:00",
      "create_time_stamp" : 1712836093000,
      "update_time_stamp" : 1712836093000,
      "create_user" : "devcloud_devcloud_s00314720_01",
      "create_time" : "2024-04-11T07:48:13+0800",
      "update_user" : "devcloud_devcloud_s00314720_01",
      "update_time" : "2024-04-11T07:48:13+0800",
      "name" : "默认文件夹",
      "param_type_and_dft_value" : null,
      "dft_custom_header" : null,
      "dft_check_point_list" : null,
      "dft_variable_list" : null,
      "keyword_variable_value" : null,
      "dft_retry_times" : "",
      "dft_retry_interval" : "",
      "return_type" : "",
      "aw_type" : 0,
      "aw_ins_list" : null,
      "project_id" : "09645c1f3f954a8d9ab29174857cffc5",
      "public_aw_lib_id" : "",
      "special_type" : null,
      "has_code" : null,
      "aw_code" : "",
      "group_name" : "",
      "protocol_type" : "",
      "by_order" : null,
      "aw_mark" : null,
      "output_param_list" : null,
      "is_favorite" : null,
      "tmss_case_id" : null,
      "create_user_id" : "",
      "aw_description" : null,
      "origin_project" : null,
      "aw_uniqueid" : null,
      "aw_tags" : null,
      "aw_operationid" : null,
      "interface_label" : null,
      "import_package" : null,
      "public_aw_lib" : null,
      "root_id" : null,
      "custom_aw_libs" : null,
      "delete_time" : null,
      "delete_user" : null,
      "parent_id" : "TOP",
      "is_folder" : "0",
      "cata_type" : 4,
      "page_no" : null,
      "page_size" : null,
      "total_page" : null,
      "total_size" : null,
      "child_list" : [ ],
      "extra_info" : null
    } ]
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;


public class ListBasicAwInfoListSupportsSearchSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CloudtestClient client = CloudtestClient.newBuilder()
                .withCredential(auth)
                .withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
                .build();
        ListBasicAwInfoListSupportsSearchRequest request = new ListBasicAwInfoListSupportsSearchRequest();
        request.withProjectId("{project_id}");
        SearchRequest body = new SearchRequest();
        body.withSearchValue("");
        body.withSearchType("");
        request.withBody(body);
        try {
            ListBasicAwInfoListSupportsSearchResponse response = client.listBasicAwInfoListSupportsSearch(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CloudtestClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListBasicAwInfoListSupportsSearchRequest()
        request.project_id = "{project_id}"
        request.body = SearchRequest(
            search_value="",
            search_type=""
        )
        response = client.list_basic_aw_info_list_supports_search(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := cloudtest.CloudtestClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := cloudtest.NewCloudtestClient(hcClient)

    request := &model.ListBasicAwInfoListSupportsSearchRequest{}
	request.ProjectId = "{project_id}"
	searchValueSearchRequest:= ""
	searchTypeSearchRequest:= ""
	request.Body = &model.SearchRequest{
		SearchValue: &searchValueSearchRequest,
		SearchType: &searchTypeSearchRequest,
	}
	response, err := client.ListBasicAwInfoListSupportsSearch(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码。

父主题： 接口测试管理

相关文档