文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V1/ 字典管理/ 获取字典信息 - ListConfigurationDictionaries
更新时间:2026-06-26 GMT+08:00
分享

获取字典信息 - ListConfigurationDictionaries

功能介绍

获取字典信息

调用方法

请参见如何调用API

授权信息

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

URI

GET /v1/{project_id}/configurations/dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

scene

String

参数解释:

字典使用场景,告警为ALERT,等级云为QUAD_CLOUD

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

level

String

参数解释:

等级云级别

约束限制:

仅scene=QUAD_CLOUD时传递

取值范围:

S1,S2,S3,S4

默认取值:

不涉及

scope

String

参数解释:

该字典作用域

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

dict_key

String

参数解释:

字典key

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

is_built_in

Boolean

参数解释:

是否为系统内置字典数据,true:系统内置,false:自定义

约束限制:

不涉及

取值范围:

true,false

默认取值:

不涉及

offset

Integer

参数解释:

分页参数:返回起始偏移量

约束限制:

不涉及

取值范围:

[0, 2000000]

默认取值:

不涉及

limit

Integer

参数解释:

分页参数:返回数据量大小

约束限制:

不涉及

取值范围:

[1, 1000]

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Language

String

参数解释:

用户当前语言环境

约束限制:

不涉及

取值范围:

  • zh-cn

  • en-us

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

success_list

Array of Dictionary objects

参数解释:

正常字典列表

约束限制:

不涉及

failed_list

Array of Dictionary objects

参数解释:

异常字典列表

约束限制:

不涉及

表5 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

参数解释:

用户当前语言环境

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

获取告警字典列表

GET https://{endpoint}/v1/{project_id}/configurations/dictionaries?scene=ALERT&offset=0&limit=100

响应示例

状态码:200

字典列表

{
  "success_list" : [ {
    "id" : "02421dc8-6c80-48ed-a705-0f149f8abb77",
    "version" : "1.0.0",
    "dict_id" : 1,
    "dict_key" : "alert_comments",
    "dict_code" : "Open",
    "dict_val" : "Open",
    "dict_pkey" : "alert_comments",
    "dict_pcode" : "Open",
    "create_time" : "2024-04-26T16:08:09Z+0800",
    "update_time" : "2024-04-26T16:08:09Z+0800",
    "publish_time" : "2024-04-26T16:08:09Z+0800",
    "scope" : "ALERT",
    "description" : "Alert",
    "extension_field" : null,
    "project_id" : "15645*****************341da6",
    "language" : "zh"
  } ],
  "failed_list" : [ {
    "id" : "02421dc8-6c80-48ed-a705-0f149f8abb77",
    "version" : "1.0.0",
    "dict_id" : 1,
    "dict_key" : "alert_comments",
    "dict_code" : "Open",
    "dict_val" : "Open",
    "dict_pkey" : "alert_comments",
    "dict_pcode" : "Open",
    "create_time" : "2024-04-26T16:08:09Z+0800",
    "update_time" : "2024-04-26T16:08:09Z+0800",
    "publish_time" : "2024-04-26T16:08:09Z+0800",
    "scope" : "ALERT",
    "description" : "Alert",
    "extension_field" : null,
    "project_id" : "15645*****************341da6",
    "language" : "zh"
  } ]
}

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
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 ListConfigurationDictionariesSolution {

    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();
        ListConfigurationDictionariesRequest request = new ListConfigurationDictionariesRequest();
        try {
            ListConfigurationDictionariesResponse response = client.listConfigurationDictionaries(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
# 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 = ListConfigurationDictionariesRequest()
        response = client.list_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, 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.ListConfigurationDictionariesRequest{}
	response, err := client.ListConfigurationDictionaries(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

字典列表

错误码

请参见错误码

相关文档