文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 字典管理/ 删除字典 - DeleteConfigurationDictionaries
更新时间:2026-01-29 GMT+08:00
分享

删除字典 - DeleteConfigurationDictionaries

功能介绍

删除字典数据

调用方法

请参见如何调用API

授权信息

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

URI

DELETE /v1/{project_id}/configurations/dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

X-Language

String

用户当前语言环境

表3 请求Body参数

参数

是否必选

参数类型

描述

dict_list

Array of DictionaryDelete objects

字典列表

is_built_in

Boolean

是否删除内置字典,默认不对外开放删除内置字典工具

表4 DictionaryDelete

参数

是否必选

参数类型

描述

dict_id

String

字典id

dict_key

String

字典key

language

String

用户当前语言环境

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

success_list

Array of Dictionary objects

正常字典列表

failed_list

Array of Dictionary objects

异常字典列表

表6 Dictionary

参数

参数类型

描述

id

String

uuid

version

String

版本号

dict_id

String

字典id

dict_key

String

字典key

dict_code

String

字典code

dict_val

String

字典值

dict_pkey

String

字典关联的父key

dict_pcode

String

字典关联的父code

create_time

String

创建时间

update_time

String

更新时间

publish_time

String

发布时间

scope

String

字典所属领域

description

String

字典描述信息

extension_field

Object

额外字段

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

language

String

用户当前语言环境

请求示例

删除指定告警字典

DELETE https://{endpoint}/v1/{project_id}/configurations/dictionaries

{
  "dict_list" : [ {
    "version" : "1.0.0",
    "dict_id" : 1,
    "dict_key" : "alert_comments",
    "language" : "zh"
  } ],
  "is_built_in" : false
}

响应示例

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.*;

import java.util.List;
import java.util.ArrayList;

public class DeleteConfigurationDictionariesSolution {

    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();
        DeleteConfigurationDictionariesRequest request = new DeleteConfigurationDictionariesRequest();
        DeleteDictionaryRequest body = new DeleteDictionaryRequest();
        List<DictionaryDelete> listbodyDictList = new ArrayList<>();
        listbodyDictList.add(
            new DictionaryDelete()
                .withDictId("1")
                .withDictKey("alert_comments")
                .withLanguage("zh")
        );
        body.withIsBuiltIn(false);
        body.withDictList(listbodyDictList);
        request.withBody(body);
        try {
            DeleteConfigurationDictionariesResponse response = client.deleteConfigurationDictionaries(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
# 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 = DeleteConfigurationDictionariesRequest()
        listDictListbody = [
            DictionaryDelete(
                dict_id="1",
                dict_key="alert_comments",
                language="zh"
            )
        ]
        request.body = DeleteDictionaryRequest(
            is_built_in=False,
            dict_list=listDictListbody
        )
        response = client.delete_configuration_dictionaries(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
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.DeleteConfigurationDictionariesRequest{}
	var listDictListbody = []model.DictionaryDelete{
        {
            DictId: "1",
            DictKey: "alert_comments",
            Language: "zh",
        },
    }
	isBuiltInDeleteDictionaryRequest:= false
	request.Body = &model.DeleteDictionaryRequest{
		IsBuiltIn: &isBuiltInDeleteDictionaryRequest,
		DictList: &listDictListbody,
	}
	response, err := client.DeleteConfigurationDictionaries(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

字典列表

错误码

请参见错误码

相关文档