文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 数据类类型/ 数据类类型新增 - CreateDataclassType
更新时间:2026-06-26 GMT+08:00
分享

数据类类型新增 - CreateDataclassType

功能介绍

新增数据类类型

调用方法

请参见如何调用API

授权信息

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

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/types

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dataclass_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参数

参数

是否必选

参数类型

描述

sub_category

String

子类型名称,告警类型、事件类型必填;威胁情报、漏洞类型、自定义类型不填

sub_category_code

String

子类型标识。告警类型、事件类型必填;威胁情报、漏洞类型、自定义类型不填

category

String

类型名称,告警类型、事件类型、威胁情报、漏洞类型必填;自定义类型不填

category_code

String

类型标识。告警类型、事件类型、威胁情报、漏洞类型必填;自定义类型不填

name

String

自定义类型名称。创建类型时,代表类型名称,创建子类型时,代表子类型名称。(自定义类型必填,其余类型不填)

business_code

String

自定义类型标识。创建类型时代表类型标识;创建子类型时代表子类型标识。(自定义类型必填,其余类型不填)

dataclass_business_code

String

数据类业务编码,创建自定义类型必填。(其余类型不填)

description

String

类型描述

level

Integer

类型层级,创建自定义类型必填,枚举值:1-类型,2-子类型。(其余类型不填)

enabled

Boolean

类型启用禁用状态,启用:true,禁用:false

sla

Long

响应时长

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

类型id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dataclass_id

String

参数解释:

数据类id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

domain_id

String

参数解释:

账号id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

project_id

String

参数解释:

项目id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

region_id

String

参数解释:

局点id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

layout_id

String

参数解释:

布局id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

layout_name

String

参数解释:

布局名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

category

String

参数解释:

数据类类型分类

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

category_code

String

参数解释:

数据类类型分类编码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sub_category

String

参数解释:

数据类子类型名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sub_category_code

String

参数解释:

数据类子类型业务编码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

description

String

参数解释:

数据类子类型描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

enabled

Boolean

参数解释:

类型启用状态

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

level

Integer

参数解释:

类型层级

约束限制:

不涉及

取值范围:

大类:1,子类型:2

默认取值:

不涉及

is_built_in

Boolean

参数解释:

是否内置,true内置,false非内置

约束限制:

不涉及

取值范围:

大类:1,子类型:2

默认取值:

不涉及

sla

Long

参数解释:

响应时长

约束限制:

不涉及

取值范围:

0-15634800000

默认取值:

不涉及

creator_id

String

参数解释:

创建人id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

creator_name

String

参数解释:

创建人名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

modifier_id

String

参数解释:

修改人id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

modifier_name

String

参数解释:

修改人名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

create_time

String

参数解释:

创建时间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

update_time

String

参数解释:

修改时间

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dataclass_business_code

String

参数解释:

所属数据类业务编码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sub_count

Integer

参数解释:

类型分类下子类型数目

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

error_msg

String

参数解释:

错误描述

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

  • 创建告警类型示例

    {
      "category" : "TestCategory",
      "category_code" : "Test Category Code",
      "sub_category" : "TestSubType",
      "sub_category_code" : "Test Alert Type Code",
      "enabled" : true,
      "sla" : 86400000,
      "description" : null
    }
  • 创建资产自定义类型大类示例

    {
      "level" : 1,
      "name" : "TestResource",
      "business_code" : "Test Resource Category Code",
      "enabled" : true,
      "sla" : 0,
      "description" : null,
      "dataclass_business_code" : "Resource"
    }

响应示例

状态码:200

新增类型成功响应体

{
  "category" : "TestAlertCategory",
  "category_code" : "Test Alert Category Code",
  "create_time" : "2025-12-19T17:31:27Z+0800",
  "creator_id" : "b40b54b1f27a4224aa0c95ede5b5a46a",
  "creator_name" : "l00644738",
  "dataclass_business_code" : "Alert",
  "dataclass_id" : "",
  "description" : "",
  "domain_id" : "",
  "enabled" : true,
  "id" : "2312dad0-0fc0-314d-bf18-5a87e99c3b16",
  "is_built_in" : false,
  "layout_id" : "",
  "layout_name" : "",
  "level" : null,
  "modifier_id" : "",
  "modifier_name" : "",
  "project_id" : "15645222e8744afa985c93dab6341da6",
  "region_id" : "",
  "sla" : 86400000,
  "sub_category" : "TestAlertSubType",
  "sub_category_code" : "Test Alert Sub Type Code",
  "sub_count" : null,
  "update_time" : null,
  "workspace_id" : "ea956472-44a9-47d6-808b-03b95d06f355"
}

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
    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 CreateDataclassTypeSolution {
    
        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();
            CreateDataclassTypeRequest request = new CreateDataclassTypeRequest();
            request.withWorkspaceId("{workspace_id}");
            request.withDataclassId("{dataclass_id}");
            CreateDataclassTypeRequestBody body = new CreateDataclassTypeRequestBody();
            body.withSla(86400000L);
            body.withEnabled(true);
            body.withCategoryCode("Test Category Code");
            body.withCategory("TestCategory");
            body.withSubCategoryCode("Test Alert Type Code");
            body.withSubCategory("TestSubType");
            request.withBody(body);
            try {
                CreateDataclassTypeResponse response = client.createDataclassType(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
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    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 CreateDataclassTypeSolution {
    
        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();
            CreateDataclassTypeRequest request = new CreateDataclassTypeRequest();
            request.withWorkspaceId("{workspace_id}");
            request.withDataclassId("{dataclass_id}");
            CreateDataclassTypeRequestBody body = new CreateDataclassTypeRequestBody();
            body.withSla(0L);
            body.withEnabled(true);
            body.withLevel(CreateDataclassTypeRequestBody.LevelEnum.NUMBER_1);
            body.withDataclassBusinessCode("Resource");
            body.withBusinessCode("Test Resource Category Code");
            body.withName("TestResource");
            request.withBody(body);
            try {
                CreateDataclassTypeResponse response = client.createDataclassType(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
    # 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 = CreateDataclassTypeRequest()
            request.workspace_id = "{workspace_id}"
            request.dataclass_id = "{dataclass_id}"
            request.body = CreateDataclassTypeRequestBody(
                sla=86400000,
                enabled=True,
                category_code="Test Category Code",
                category="TestCategory",
                sub_category_code="Test Alert Type Code",
                sub_category="TestSubType"
            )
            response = client.create_dataclass_type(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
    # 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 = CreateDataclassTypeRequest()
            request.workspace_id = "{workspace_id}"
            request.dataclass_id = "{dataclass_id}"
            request.body = CreateDataclassTypeRequestBody(
                sla=0,
                enabled=True,
                level=1,
                dataclass_business_code="Resource",
                business_code="Test Resource Category Code",
                name="TestResource"
            )
            response = client.create_dataclass_type(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
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    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, err := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            SafeBuild()
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        hcClient, err := secmaster.SecMasterClientBuilder().
             WithRegion(region.ValueOf("<YOUR REGION>")).
             WithCredential(auth).
             SafeBuild()
    
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        client := secmaster.NewSecMasterClient(hcClient)
    
        request := &model.CreateDataclassTypeRequest{}
    	request.WorkspaceId = "{workspace_id}"
    	request.DataclassId = "{dataclass_id}"
    	categoryCodeCreateDataclassTypeRequestBody:= "Test Category Code"
    	categoryCreateDataclassTypeRequestBody:= "TestCategory"
    	subCategoryCodeCreateDataclassTypeRequestBody:= "Test Alert Type Code"
    	subCategoryCreateDataclassTypeRequestBody:= "TestSubType"
    	request.Body = &model.CreateDataclassTypeRequestBody{
    		Sla: int64(86400000),
    		Enabled: true,
    		CategoryCode: &categoryCodeCreateDataclassTypeRequestBody,
    		Category: &categoryCreateDataclassTypeRequestBody,
    		SubCategoryCode: &subCategoryCodeCreateDataclassTypeRequestBody,
    		SubCategory: &subCategoryCreateDataclassTypeRequestBody,
    	}
    	response, err := client.CreateDataclassType(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    
  • 创建资产自定义类型大类示例

     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
    62
    63
    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, err := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithProjectId(projectId).
            SafeBuild()
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        hcClient, err := secmaster.SecMasterClientBuilder().
             WithRegion(region.ValueOf("<YOUR REGION>")).
             WithCredential(auth).
             SafeBuild()
    
    
        if err != nil {
            fmt.Println(err)
            return
        }
    
        client := secmaster.NewSecMasterClient(hcClient)
    
        request := &model.CreateDataclassTypeRequest{}
    	request.WorkspaceId = "{workspace_id}"
    	request.DataclassId = "{dataclass_id}"
    	levelCreateDataclassTypeRequestBody:= model.GetCreateDataclassTypeRequestBodyLevelEnum().E_1
    	dataclassBusinessCodeCreateDataclassTypeRequestBody:= "Resource"
    	businessCodeCreateDataclassTypeRequestBody:= "Test Resource Category Code"
    	nameCreateDataclassTypeRequestBody:= "TestResource"
    	request.Body = &model.CreateDataclassTypeRequestBody{
    		Sla: int64(0),
    		Enabled: true,
    		Level: &levelCreateDataclassTypeRequestBody,
    		DataclassBusinessCode: &dataclassBusinessCodeCreateDataclassTypeRequestBody,
    		BusinessCode: &businessCodeCreateDataclassTypeRequestBody,
    		Name: &nameCreateDataclassTypeRequestBody,
    	}
    	response, err := client.CreateDataclassType(request)
    	if err == nil {
            fmt.Printf("%+v\n", response)
        } else {
            fmt.Println(err)
        }
    }
    

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

状态码

状态码

描述

200

新增类型成功响应体

400

新增类型失败响应体

错误码

请参见错误码

相关文档