Updated on 2026-11-11 GMT+08:00

Querying Cluster Security Parameter Settings

Function

Query cluster security parameter settings.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/clusters/{cluster_id}/security-configurations/{configuration_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see [Obtaining a Project ID] (dws_02_0011.xml).

Constraints:

None

Range:

None

Default Value:

None

cluster_id

Yes

String

Definition:

Cluster ID For details about how to obtain the cluster ID, see [Obtaining the Cluster ID] (dws_02_00068.xml).

Constraints:

None

Range:

None

Default Value:

None

configuration_id

Yes

String

Definition:

Parameter template ID.

Constraints:

None

Range:

None

Default Value:

None

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition:

Size of each page to be queried

Constraints:

None

Range:

None

Default Value:

100

offset

No

Integer

Definition:

Page offset. The value starts from 0 and decreases by 1.

Constraints:

None

Range:

≥ 0

Default Value:

0

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

configurations

Array of SecurityConfigurationParameter objects

Definition:

Parameter list.

Range:

None

count

Integer

Definition:

Total number of records.

Range:

None

Table 4 SecurityConfigurationParameter

Parameter

Type

Description

name

String

Definition:

Parameter name.

Range:

audit_dml_state: indicates the switch for auditing DML operations.

audit_system_object: audits DDL operations and other operations.

audit_adm: indicates the user name of the security administrator.

audit_exec_status: audit execution result;

audit_operation_checked: audits DML operations and other operations.

enableSeparationOfDuty: indicates the separation of duties.

audit_user_violation: unauthorized access;

ssl: SSL switch;

require_ssl: indicates whether to verify SSL.

audit_function_exec: audits the execution of stored procedures.

audit_copy_exec: records the COPY operation.

audit_resource_policy: log retention policy;

Audit_file_remain_time: minimum number of days for storing data in a time policy, which has been discarded.

Audit_dml_state_select: audits the SELECT operation.

security_adm: security administrator;

audit_dump_switch: log dump switch;

Kernel_audit_dump_switch: indicates the kernel log dump switch.

Audit_system_object_detail: specifies the options for auditing DDL operations and other operations.

value

String

Definition:

Parameter value

Range:

None

Example Requests

Query cluster security parameter settings.

GET https://{Endpoint}/v1/169439ece752470aa5171633e9d3e47f/clusters/50aee999-9215-4dd0-a142-254ac6bf80e7/security-configurations/b970ffd4-4502-46c8-adc7-9b8c49261060?limit=5&offset=3

Example Responses

Status code: 200

{
  "configurations" : [ {
    "name" : "audit_dump_switch",
    "value" : "0"
  }, {
    "name" : "kernel_audit_dump_switch",
    "value" : "0"
  }, {
    "name" : "audit_system_object_detail",
    "value" : "NODE,SEQUENCE,TEXT SEARCH,TYPE,NODE GROUP,DATA SOURCE,SERVER FOR HADOOP,WORKLOAD,TRIGGER,VIEW,TABLE,USER,SCHEMA,DATABASE"
  } ],
  "count" : 18
}

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
48
49
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.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class ListClusterSecurityConfigurationsSolution {

    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);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListClusterSecurityConfigurationsRequest request = new ListClusterSecurityConfigurationsRequest();
        request.withClusterId("{cluster_id}");
        request.withConfigurationId("{configuration_id}");
        try {
            ListClusterSecurityConfigurationsResponse response = client.listClusterSecurityConfigurations(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 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 = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListClusterSecurityConfigurationsRequest()
        request.cluster_id = "{cluster_id}"
        request.configuration_id = "{configuration_id}"
        response = client.list_cluster_security_configurations(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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/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 := dws.DwsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dws.NewDwsClient(hcClient)

    request := &model.ListClusterSecurityConfigurationsRequest{}
	request.ClusterId = "{cluster_id}"
	request.ConfigurationId = "{configuration_id}"
	response, err := client.ListClusterSecurityConfigurations(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

Queried.

400

Bad Request

401

authenticate failed.

403

Insufficient permissions.

404

No resources found.

500

An internal service error occurred.

503

Service unavailable.