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

Querying Dictionary Information

Function

This API is used to query dictionary information.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/configurations/dictionaries

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that the 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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

scene

No

String

Dictionary application scenario. The value is ALERT for alerts and QUAD_CLOUD for graded clouds.

level

No

String

[S1, S2, S3, S4] is used only in the QUAD_CLOUD scenario.

scope

No

String

Application domain of the dictionary.

dict_key

No

String

Dictionary key.

is_built_in

No

Boolean

Whether the dictionary data is built-in. true: built-in; false: custom.

offset

No

Integer

Start offset for pagination query.

limit

No

Integer

Returned data volume for pagination query.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

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

X-Language

Yes

String

Current language.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success_list

Array of Dictionary objects

Normal dictionary list.

failed_list

Array of Dictionary objects

Abnormal dictionary list

Table 5 Dictionary

Parameter

Type

Description

id

String

uuid

version

String

Version number.

dict_id

String

Dictionary ID.

dict_key

String

Dictionary key.

dict_code

String

Dictionary code.

dict_val

String

Dictionary value.

dict_pkey

String

Parent key associated with the dictionary.

dict_pcode

String

Parent code associated with the dictionary.

create_time

String

Creation time.

update_time

String

Update time.

publish_time

String

Release time.

scope

String

Domain the dictionary belongs to.

description

String

Dictionary description.

extension_field

Object

Additional field.

project_id

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

language

String

Current language.

Example Requests

This API is used to query the dictionary list.

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

Example Responses

Status code: 200

Dictionary list.

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

The SDK sample code is as follows.

 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
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.ListConfigurationDictionariesRequest{}
	response, err := client.ListConfigurationDictionaries(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

Dictionary list.

Error Codes

See Error Codes.