获取父目录下关键字列表（含目录） - ListChildBasicAws

功能介绍

在项目中，获取父目录下关键字列表（含目录）

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/aw_cata/child_cata_data

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及取值范围: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字默认取值: 不涉及

表2 Query参数
参数	是否必选	参数类型	描述
aw_name	否	String	过滤条件
is_contain_aw	否	String	返回值是否包含关键字脚本
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	CommonResponseErrorListBasicAwCata object	参数解释统一错误返回取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串
result	Array of BasicAwCata objects	参数解释结果取值范围不涉及
status	String	参数解释 '状态值，如success、error' 取值范围 success，请求成功 error，请求报错

表5 CommonResponseErrorListBasicAwCata
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
detail	Array of BasicAwCata objects	参数解释错误信息详情取值范围不涉及
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个字符组成的字符串

状态码：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个字符组成的字符串

请求示例

get https://{endpoint}/v1/894d280bd0364dc8a21d9a3e3e0b4421/aw_cata/child_cata_data?source_type=1&aw_name=&is_contain_aw=false&parent_id=

响应示例

状态码：200

{
  "status" : "success",
  "result" : [ {
    "id" : "814255a5cc8c4df686098025ecab9ea1",
    "name" : "cataFolder_KxyQI",
    "desc" : "",
    "nameView" : null,
    "region" : null,
    "create_user" : null,
    "create_time" : null,
    "update_user" : null,
    "update_time" : null,
    "parent_id" : "TOP",
    "project_id" : null,
    "is_folder" : null,
    "aw_dir" : null,
    "refCnt" : null,
    "extra_info" : null,
    "create_user_id" : null,
    "cata_type" : 3
  }, {
    "id" : "c337ce62507b42b99e315af48396bf31",
    "name" : "Default Folder",
    "desc" : null,
    "nameView" : null,
    "region" : null,
    "create_user" : null,
    "create_time" : null,
    "update_user" : null,
    "update_time" : null,
    "parent_id" : "TOP",
    "project_id" : null,
    "is_folder" : null,
    "aw_dir" : null,
    "refCnt" : null,
    "extra_info" : null,
    "create_user_id" : null,
    "cata_type" : 4
  } ],
  "reason" : null,
  "error" : null,
  "code" : null
}