更新时间:2026-01-29 GMT+08:00
分享

修改目录 - UpdateCatalogue

功能介绍

修改自定义目录

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用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

布局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" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "layout_name" : "test",
  "publisher_name" : "test",
  "parent_alias_zh" : "parent_alias",
  "parent_alias_en" : "parent_alias",
  "second_alias_en" : "second_alias",
  "catalogue_address" : "/ssa/workspace/soc/custom",
  "second_catalogue" : "second"
}

响应示例

状态码: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_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"
  }
}

SDK代码示例

SDK代码示例如下。

更新目录请求体

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v1.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v1.*;
import com.huaweicloud.sdk.secmaster.v1.model.*;


public class UpdateCatalogueSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateCatalogueRequest request = new UpdateCatalogueRequest();
        request.withWorkspaceId("{workspace_id}");
        request.withCatalogueId("{catalogue_id}");
        CatalogueUpdateRequestPojo body = new CatalogueUpdateRequestPojo();
        body.withPublisherName("发布者");
        body.withCatalogueAddress("/ssa/workspace/soc/custom");
        body.withLayoutName("test");
        body.withLayoutId("909494e3-558e-46b6-a9eb-07a8e18ca62f");
        body.withSecondAliasZh("alias_zh");
        body.withSecondAliasEn("二级目录英文别名");
        body.withSecondCatalogue("二级目录名称");
        body.withParentAliasZh("一级目录中文别名");
        body.withParentAliasEn("一级目录英文别名");
        request.withBody(body);
        try {
            UpdateCatalogueResponse response = client.updateCatalogue(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

更新目录请求体

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateCatalogueRequest()
        request.workspace_id = "{workspace_id}"
        request.catalogue_id = "{catalogue_id}"
        request.body = CatalogueUpdateRequestPojo(
            publisher_name="发布者",
            catalogue_address="/ssa/workspace/soc/custom",
            layout_name="test",
            layout_id="909494e3-558e-46b6-a9eb-07a8e18ca62f",
            second_alias_zh="alias_zh",
            second_alias_en="二级目录英文别名",
            second_catalogue="二级目录名称",
            parent_alias_zh="一级目录中文别名",
            parent_alias_en="一级目录英文别名"
        )
        response = client.update_catalogue(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

更新目录请求体

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateCatalogueRequest{}
	request.WorkspaceId = "{workspace_id}"
	request.CatalogueId = "{catalogue_id}"
	publisherNameCatalogueUpdateRequestPojo:= "发布者"
	layoutNameCatalogueUpdateRequestPojo:= "test"
	request.Body = &model.CatalogueUpdateRequestPojo{
		PublisherName: &publisherNameCatalogueUpdateRequestPojo,
		CatalogueAddress: "/ssa/workspace/soc/custom",
		LayoutName: &layoutNameCatalogueUpdateRequestPojo,
		LayoutId: "909494e3-558e-46b6-a9eb-07a8e18ca62f",
		SecondAliasZh: "alias_zh",
		SecondAliasEn: "二级目录英文别名",
		SecondCatalogue: "二级目录名称",
		ParentAliasZh: "一级目录中文别名",
		ParentAliasEn: "一级目录英文别名",
	}
	response, err := client.UpdateCatalogue(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

错误码

请参见错误码

相关文档