更新时间:2025-08-30 GMT+08:00
分享

修改目录

功能介绍

修改自定义目录

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/catalogues/{catalogue_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

catalogue_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_alias_en

String

一级目录英文别名

parent_alias_zh

String

一级目录中文别名

second_catalogue

String

二级目录名称

second_alias_en

String

二级目录英文别名

second_alias_zh

String

二级目录中文别名

layout_id

String

layout id.

layout_name

String

layout name

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

Error message

表6 CatalogueDetailInfo

参数

参数类型

描述

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

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为:request_uuid-timestamp-hostname

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档