文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 目录定制/ 创建自定义目录 - CreateCatalogue
更新时间：2025-12-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建自定义目录 - CreateCatalogue

功能介绍

新增自定义目录

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/catalogues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

workspace_id

是

String

参数解释：

工作空间id。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

content-type

是

String

参数解释：

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制：

不涉及

取值范围：

  • application/json;charset=UTF-8

默认取值：

不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

parent_catalogue

是

String

一级目录名称

parent_alias_en

是

String

一级目录英文别名

parent_alias_zh

是

String

一级目录中文别名

second_catalogue

是

String

二级目录名称

second_alias_en

是

String

二级目录英文别名

second_alias_zh

是

String

二级目录中文别名

second_catalogue_code

是

String

目录编码

layout_id

是

String

布局ID.

layout_name

否

String

布局名称

catalogue_address

是

String

目录地址

publisher_name

否

String

发布者

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表5 响应Body参数

参数

参数类型

描述

code

String

错误码

data

CatalogueDetailInfo object

目录详情信息

message

String

响应信息
表6 CatalogueDetailInfo

参数

参数类型

描述

id

String

目录id

parent_catalogue

String

一级目录名称

second_catalogue

String

二级目录名称

catalogue_status

Boolean

是否内置

catalogue_address

String

目录地址

layout_id

String

布局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

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

创建目录请求体

{
  "second_alias_zh" : "alias_zh",
  "layout_id" : "7685334e-6fc3-4be1-a8f9-f0cd4cf080dc",
  "layout_name" : "test",
  "publisher_name" : "发布者",
  "parent_alias_zh" : "一级目录中文别名",
  "parent_alias_en" : "一级目录英文别名",
  "second_alias_en" : "二级目录英文别名",
  "second_catalogue_code" : "report",
  "catalogue_address" : "/ssa/workspace/soc/custom",
  "parent_catalogue" : "一级目录名称",
  "second_catalogue" : "二级目录名称"
}

响应示例

状态码：200

请求成功

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "data" : {
    "catalogue_address" : "/ssa/workspace/soc/custom",
    "id" : "01a09270-33c1-4918-ab74-dc746acb8f8d",
    "is_card_area" : true,
    "is_display" : true,
    "is_landing_page" : false,
    "is_navigation" : true,
    "layout_id" : "7685334e-6fc3-4be1-a8f9-f0cd4cf080dc",
    "layout_is_built_in" : null,
    "layout_name" : "test",
    "parent_alias_en" : "parent_alias_en",
    "parent_alias_zh" : "alias_zh",
    "parent_catalogue" : "parent_catalogue",
    "publisher_name" : "SCC_InfrastructureSecurityService",
    "second_alias_en" : "alias_en",
    "second_alias_zh" : "alias_zh",
    "second_catalogue" : "second",
    "update_time" : null
  }
}

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码。

父主题： 目录定制

相关文档