Updated on 2026-02-05 GMT+08:00

Creating a Custom Directory

Function

This API is used to create a custom directory.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

parent_catalogue

Yes

String

Level-1 directory name.

parent_alias_en

Yes

String

Level-1 directory alias (English).

parent_alias_zh

Yes

String

Level-1 directory alias (Chinese).

second_catalogue

Yes

String

Level-2 directory name.

second_alias_en

Yes

String

Level-2 directory alias (English).

second_alias_zh

Yes

String

Level-2 directory alias (Chinese).

second_catalogue_code

Yes

String

Directory code.

layout_id

Yes

String

Layout ID.

layout_name

No

String

Layout name.

catalogue_address

Yes

String

Directory address.

publisher_name

No

String

Publisher.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code.

data

CatalogueDetailInfo object

Directory details.

message

String

Response information.

Table 6 CatalogueDetailInfo

Parameter

Type

Description

id

String

Directory ID.

parent_catalogue

String

Level-1 directory name.

second_catalogue

String

Level-2 directory name.

catalogue_status

Boolean

Whether the directory is built in the system.

catalogue_address

String

Directory address.

layout_id

String

Layout ID.

layout_name

String

Layout name.

publisher_name

String

Publisher.

is_card_area

Boolean

Whether to display the card area.

is_display

Boolean

Whether to display the directory.

is_landing_page

Boolean

Whether the page is a landing page.

is_navigation

Boolean

Whether to display the breadcrumb navigation.

parent_alias_en

String

Level-1 directory alias (English).

parent_alias_zh

String

Level-1 directory alias (Chinese).

second_alias_en

String

Level-2 directory alias (English).

second_alias_zh

String

Level-2 directory alias (Chinese).

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Request body for creating a directory.

{
  "second_alias_zh" : "alias_zh",
  "layout_id" : "7685334e-6fc3-4be1-a8f9-f0cd4cf080dc",
  "layout_name" : "test",
  "publisher_name" : "test",
  "parent_alias_zh" : "parent_alias",
  "parent_alias_en" : "parent_alias",
  "second_alias_en" : "second_alias",
  "second_catalogue_code" : "report",
  "catalogue_address" : "/ssa/workspace/soc/custom",
  "parent_catalogue" : "parent",
  "second_catalogue" : "second"
}

Example Responses

Status code: 200

Request succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

Request body for creating a directory.

 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
61
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 CreateCatalogueSolution {

    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();
        CreateCatalogueRequest request = new CreateCatalogueRequest();
        request.withWorkspaceId("{workspace_id}");
        CatalogueRequestPojo body = new CatalogueRequestPojo();
        body.withPublisherName("test");
        body.withCatalogueAddress("/ssa/workspace/soc/custom");
        body.withLayoutName("test");
        body.withLayoutId("7685334e-6fc3-4be1-a8f9-f0cd4cf080dc");
        body.withSecondCatalogueCode("report");
        body.withSecondAliasZh("alias_zh");
        body.withSecondAliasEn("second_alias");
        body.withSecondCatalogue("second");
        body.withParentAliasZh("parent_alias");
        body.withParentAliasEn("parent_alias");
        body.withParentCatalogue("parent");
        request.withBody(body);
        try {
            CreateCatalogueResponse response = client.createCatalogue(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());
        }
    }
}

Request body for creating a directory.

 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
# 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 = CreateCatalogueRequest()
        request.workspace_id = "{workspace_id}"
        request.body = CatalogueRequestPojo(
            publisher_name="test",
            catalogue_address="/ssa/workspace/soc/custom",
            layout_name="test",
            layout_id="7685334e-6fc3-4be1-a8f9-f0cd4cf080dc",
            second_catalogue_code="report",
            second_alias_zh="alias_zh",
            second_alias_en="second_alias",
            second_catalogue="second",
            parent_alias_zh="parent_alias",
            parent_alias_en="parent_alias",
            parent_catalogue="parent"
        )
        response = client.create_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)

Request body for creating a directory.

 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
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.CreateCatalogueRequest{}
	request.WorkspaceId = "{workspace_id}"
	publisherNameCatalogueRequestPojo:= "test"
	layoutNameCatalogueRequestPojo:= "test"
	request.Body = &model.CatalogueRequestPojo{
		PublisherName: &publisherNameCatalogueRequestPojo,
		CatalogueAddress: "/ssa/workspace/soc/custom",
		LayoutName: &layoutNameCatalogueRequestPojo,
		LayoutId: "7685334e-6fc3-4be1-a8f9-f0cd4cf080dc",
		SecondCatalogueCode: "report",
		SecondAliasZh: "alias_zh",
		SecondAliasEn: "second_alias",
		SecondCatalogue: "second",
		ParentAliasZh: "parent_alias",
		ParentAliasEn: "parent_alias",
		ParentCatalogue: "parent",
	}
	response, err := client.CreateCatalogue(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.