目录列表查询 - ListCatalogue
功能介绍
目录列表查询
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/catalogues/search
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
参数解释: 数据量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
offset |
否 |
Integer |
参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
parent_catalogue |
否 |
String |
一级目录名称 |
|
second_catalogue |
否 |
String |
二级目录名称 |
|
catalogue_status |
否 |
Boolean |
是否内置 |
|
layout_name |
否 |
String |
布局名称 |
|
publisher_name |
否 |
String |
发布者 |
|
analysis_version |
否 |
String |
安全分析版本 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
data |
Array of CatalogueDetailInfo objects |
数据列表 |
|
message |
String |
Error message |
|
request_id |
String |
Request id |
|
success |
Boolean |
是否响应成功 |
|
total |
Integer |
tatal count |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
目录id |
|
parent_catalogue |
String |
一级目录名称 |
|
second_catalogue |
String |
二级目录名称 |
|
catalogue_status |
Boolean |
是否内置 |
|
catalogue_address |
String |
目录地址 |
|
layout_id |
String |
layout id. |
|
layout_name |
String |
布局名称 |
|
publisher_name |
String |
发布者 |
|
is_card_area |
Boolean |
是否展示名片区 |
|
is_display |
Boolean |
是否展示目录 |
|
is_landing_page |
Boolean |
是否为落地页 |
|
is_navigation |
Boolean |
是否展示面包屑导航 |
|
parent_alias_en |
String |
一级目录英文别名 |
|
parent_alias_zh |
String |
一级目录中文别名 |
|
second_alias_en |
String |
二级目录英文别名 |
|
second_alias_zh |
String |
二级目录中文别名 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为:request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求失败 |
错误码
请参见错误码。