文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 创建关键字目录 - CreateAwCataFirst
更新时间:2026-07-07 GMT+08:00
分享

创建关键字目录 - CreateAwCataFirst

功能介绍

根据工程唯一标识和关键字目录信息创建关键字目录

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/aw_cata/create_aw_cata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

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

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

CreateAwCataFirstRequestBody

String

创建关键字目录请求参数

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

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

error

CommonResponseErrorBasicAwCata object

参数解释

统一错误返回

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

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

result

BasicAwCata object

参数解释

结果

取值范围

不涉及

status

String

参数解释

'状态值,如success、error'

取值范围

  • success,请求成功

  • error,请求报错

表5 CommonResponseErrorBasicAwCata

参数

参数类型

描述

code

String

参数解释

接口调用失败错误码

取值范围

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

detail

BasicAwCata object

参数解释

错误信息详情

取值范围

不涉及

reason

String

参数解释

接口调用失败原因

取值范围

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

表6 BasicAwCata

参数

参数类型

描述

aw_dir

String

关键字归属目录信息

cata_type

Integer

目录层级

取值范围

  • 1,title

  • 2,tags

  • 3,customize

  • 4,default folder

  • 7,combined aw folder

create_time

String

参数解释

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

取值范围

不涉及

create_user

String

参数解释

创建者

取值范围

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

create_user_id

String

参数解释

创建者唯一标识

取值范围

32个字符组成的字符串

desc

String

目录描述

extra_info

String

引用次数

id

String

参数解释

唯一标识

取值范围

32个字符组成的字符串

is_folder

String

参数解释

判断是否为文件夹的标识

取值范围

  • 0,文件

  • 1,文件夹

name

String

参数解释

名称

取值范围

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

nameView

String

参数解释

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

取值范围

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

parent_id

String

参数解释

关键字目录父编号

取值范围

32个字符组成的字符串

project_id

String

参数解释

工程唯一标识

取值范围

32个字符组成的字符串

refCnt

Integer

引用次数

region

String

参数解释

区域名称

取值范围

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

update_time

String

参数解释

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

取值范围

不涉及

update_user

String

参数解释

更新者

取值范围

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

状态码:201

Created

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

请求示例

post https://{endpoint}/v1/8946a0e4757243cc886a307916aab90b/aw_cata/create_aw_cata

"{ 
  "aw_type": "",
  "desc": "",
  "name": "cataFolder_Pwalm",
  "parent_id": "TOP"
}"

响应示例

状态码:200

OK

{
  "error" : {
    "code" : "APITEST.00010144",
    "reason" : "输入字符不合法"
  },
  "status" : "error"
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档