文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 分页获取工程关键字详细信息列表(含目录) - ListBasicAwInfoList
更新时间:2026-07-07 GMT+08:00
分享

分页获取工程关键字详细信息列表(含目录) - ListBasicAwInfoList

功能介绍

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

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/aw_cata/aw_info_list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

aw_name

String

参数解释

过滤条件:关键字名称

约束限制

不涉及

取值范围

0-128

默认取值

不涉及

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万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

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

error

CommonResponseErrorPageResultVariableGroup object

参数解释

统一错误返回

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

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

result

PageResultVariableGroup object

参数解释

响应结果

取值范围

不涉及

status

String

参数解释

'状态值,如success、error'

取值范围

  • success,请求成功

  • error,请求报错

表5 CommonResponseErrorPageResultVariableGroup

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

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

detail

PageResultVariableGroup object

参数解释

错误信息详情

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

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

表6 PageResultVariableGroup

参数

参数类型

描述

page_list

Array of VariableGroup objects

参数解释

当前页数据

取值范围

不涉及

page_no

Integer

参数解释

当前页数

约束限制

不涉及

取值范围

0-999999999

默认取值

不涉及

page_size

Integer

参数解释

每页条数

约束限制

不涉及

取值范围

0-100

默认取值

不涉及

total_page

Integer

参数解释

总页数

取值范围

0-999999999

total_size

Long

参数解释

总条数

取值范围

0-999999999

表7 VariableGroup

参数

参数类型

描述

create_time

String

参数解释

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

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

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

description

String

描述

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

isDefault

String

参数解释

是否是默认

取值范围

  • 1,默认

  • 0,非默认

name

String

参数解释

名称

取值范围

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

projectId

String

参数解释

项目唯一标识

取值范围

32个字符组成的字符串

region

String

参数解释

区域名称

取值范围

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

update_time

String

参数解释

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

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

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

variableList

Array of Variable objects

参数解释

融合变量

取值范围

不涉及

表8 Variable

参数

参数类型

描述

by_order

Integer

参数解释

顺序

取值范围

0-9999

category

String

参数解释

节点顺序

取值范围

自然数

create_time

String

参数解释

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

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

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

currentPermission

String

参数解释

当前用户权限

取值范围

不涉及

description

String

描述

dynamicParamFlag

Boolean

参数解释

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

  • true,代表动态参数

  • false,代表非动态参数

functionParams

String

参数解释

变量参数([]:空参、[a]:一参,[a,b]:两参)

取值范围

不涉及

groupId

String

参数解释

环境参数分组唯一标识

取值范围

32个字符组成的字符串

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

isSensitiveInfo

Boolean

参数解释

是否是敏感字段

取值范围

  • true,

  • false

isSensitiveModified

Boolean

参数解释

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

取值范围

  • true,

  • false

locked

Integer

参数解释

是否上锁 上锁以后的全局变量进行工程复制时不会被覆盖

  • 0,未上锁

  • 1,上锁

name

String

参数解释

名称

取值范围

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

node_id

String

参数解释

节点唯一标识

取值范围

32个字符组成的字符串

node_type

Integer

参数解释

节点类型

取值范围

  • 0,变量节点

  • null,变量节点

  • 1,目录节点

parent_id

String

参数解释

关键字目录父编号

取值范围

32个字符组成的字符串

parent_node_id

String

参数解释

父节点唯一标识

取值范围

32个字符组成的字符串

property

String

参数解释

属性

取值范围

不涉及

region

String

参数解释

区域名称

取值范围

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

sensitiveInfoSetterTime

String

参数解释

敏感参数设置时间

取值范围

不涉及

sensitiveInfoSetterUser

String

参数解释

敏感参数设置者名称

取值范围

不涉及

sourceId

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

update_time

String

参数解释

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

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

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

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编码参数

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:403

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:404

表11 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

请求示例

get https://{endpoint}/v1/1ac05b43669448f3bcc52446b1aa0b11/aw_cata/aw_info_list?aw_name=&page_no=1&page_size=10&parent_id=TOP

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "page_no" : 1,
    "page_size" : 10,
    "total_page" : 1,
    "total_size" : 0,
    "page_list" : [ ]
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档