查询目录下关键字总数以及ID - SearchBasicAwIdAndTotalUsingPOST
功能介绍
查询目录下关键字总数以及ID，批量处理场景调用
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/basic-aw/ids
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID 约束限制: 不涉及 取值范围: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
aw_type |
否 |
String |
关键字类型
|
|
search_type |
否 |
String |
搜索类型 |
|
search_value |
否 |
String |
搜索值 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 必传。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
[数组元素] |
是 |
Array of BasicAwCata objects |
搜索关键字请求参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
更新人 |
响应参数
状态码：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个字符组成的字符串 |
请求示例
[ {
"create_user_id" : "",
"create_time" : "",
"nameView" : "",
"is_folder" : "",
"refCnt" : 0,
"update_time" : "",
"extra_info" : "",
"update_user" : "",
"project_id" : "",
"parent_id" : "144c53c756f440648b86e04ccafb3dd7",
"name" : "",
"aw_dir" : "",
"create_user" : "",
"id" : "",
"region" : "",
"cata_type" : 0,
"desc" : ""
} ]
响应示例
状态码：200
SUCCESS
{
"status" : "success",
"result" : {
"total" : 1,
"value" : [ "144c53c756f440648b86e04ccafb3dd7" ]
},
"reason" : null,
"error" : null
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
SUCCESS |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
ERROR |
错误码
请参见错误码。
