获取父目录下关键字列表（含目录） - ListChildBasicAws
功能介绍
在项目中，获取父目录下关键字列表（含目录）
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/aw_cata/child_cata_data
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
aw_name |
否 |
String |
过滤条件 |
|
is_contain_aw |
否 |
String |
返回值是否包含关键字脚本 |
|
parent_id |
是 |
String |
上级目录编号 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
error |
统一错误返回 |
|
|
reason |
String |
失败原因 |
|
result |
Array of BasicAwCata objects |
结果 |
|
status |
String |
状态
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
detail |
Array of BasicAwCata objects |
错误信息详情 |
|
reason |
String |
错误原因 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
aw_dir |
String |
关键字归属目录信息 |
|
cata_type |
Integer |
目录层级
|
|
create_time |
String |
创建时间 |
|
create_user |
String |
创建人 |
|
create_user_id |
String |
创建人唯一标识 |
|
desc |
String |
目录描述 |
|
extra_info |
String |
引用次数 |
|
id |
String |
唯一标识 |
|
is_folder |
String |
判断是否为文件夹的标识 |
|
name |
String |
名称 |
|
nameView |
String |
关键字在页面上显示的名字 |
|
parent_id |
String |
关键字目录父编号 |
|
project_id |
String |
工程唯一标识 |
|
refCnt |
Integer |
引用次数 |
|
region |
String |
区域名称 |
|
update_time |
String |
更新时间 |
|
update_user |
String |
更新人 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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
OK
{
"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
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
