分页获取工程关键字详细信息列表(含目录)
功能介绍
分页获取工程关键字列表(含目录)
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/aw_cata/aw_info_list
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目唯一标识。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
aw_type |
否 |
String |
关键字类型1-普通关键字,2-组合关键字,3-导入关键字 |
|
cata_type |
否 |
Integer |
目录层级 |
|
current_project_id |
否 |
String |
工程唯一标识 |
|
is_positive_order |
否 |
Boolean |
是否按名称正序排序 |
|
page_no |
否 |
Integer |
当前页数 |
|
page_size |
否 |
Integer |
每页多少记录 |
|
parent_id |
否 |
String |
关键字目录父编号 |
|
search_type |
否 |
String |
过滤类型 |
|
search_value |
否 |
String |
过滤条件 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error |
CommonResponseErrorOfobject object |
统一错误返回 |
|
reason |
String |
错误原因 |
|
result |
Object |
结果 |
|
status |
String |
状态值,如success、error |
状态码: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个字符组成的字符串 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 12-18个字符组成的字符串 |
|
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 3-1000个字符组成的字符串 |
请求示例
{
"parent_id" : "TOP",
"page_no" : 1,
"page_size" : 50,
"search_type" : "name",
"search_value" : "kafka",
"cata_type" : 0
}
响应示例
状态码:200
SUCCESS
{
"status" : "success",
"result" : {
"page_no" : 1,
"page_size" : 0,
"total_page" : 0,
"total_size" : 0,
"page_list" : [ ]
},
"reason" : null,
"error" : null
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
SUCCESS |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
ERROR |
错误码
请参见错误码。