Help Center> GaussDB(DWS)> API Reference> API Description> Cluster Management> Modifying Parameter Settings of a Cluster
Updated on 2024-04-18 GMT+08:00

Modifying Parameter Settings of a Cluster

Function

This API is used to modify the parameter settings of a cluster.

Call Method

For details, see Calling APIs.

URI

1
PUT /v2/{project_id}/clusters/{cluster_id}/configurations/{configuration_id}
Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the ID, see Obtaining Project ID.

cluster_id

Yes

String

Cluster ID. For details about how to obtain the ID, see Obtaining the Cluster ID.

configuration_id

Yes

String

Parameter group ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

configurations

Yes

Array of ConfigurationParameterValue objects

Cluster parameter configuration list

Table 3 ConfigurationParameterValue

Parameter

Mandatory

Type

Description

type

Yes

String

Parameter type. The options are CN and DN.

name

Yes

String

Parameter name

value

Yes

String

Parameter value

Response Parameters

None

Example Request

Set the CN type and DN type in the enable_constraint_optimization parameter to off:

PUT https://{Endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/configurations/2846d355-cd2a-4239-ae54-a7aef0b7963d

{
  "configurations" : [ {
    "type" : "cn",
    "name" : "enable_constraint_optimization",
    "value" : "off"
  }, {
    "type" : "dn",
    "name" : "enable_constraint_optimization",
    "value" : "off"
  } ]
}

Example Response

None

SDK Sample Code

The 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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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.*;

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

public class UpdateConfigurationSolution {

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

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateConfigurationRequest request = new UpdateConfigurationRequest();
        ConfigurationParameterValues body = new ConfigurationParameterValues();
        List<ConfigurationParameterValue> listbodyConfigurations = new ArrayList<>();
        listbodyConfigurations.add(
            new ConfigurationParameterValue()
                .withType("cn")
                .withName("enable_constraint_optimization")
                .withValue("off")
        );
        listbodyConfigurations.add(
            new ConfigurationParameterValue()
                .withType("dn")
                .withName("enable_constraint_optimization")
                .withValue("off")
        );
        body.withConfigurations(listbodyConfigurations);
        request.withBody(body);
        try {
            UpdateConfigurationResponse response = client.updateConfiguration(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
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateConfigurationRequest()
        listConfigurationsbody = [
            ConfigurationParameterValue(
                type="cn",
                name="enable_constraint_optimization",
                value="off"
            ),
            ConfigurationParameterValue(
                type="dn",
                name="enable_constraint_optimization",
                value="off"
            )
        ]
        request.body = ConfigurationParameterValues(
            configurations=listConfigurationsbody
        )
        response = client.update_configuration(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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateConfigurationRequest{}
	var listConfigurationsbody = []model.ConfigurationParameterValue{
        {
            Type: "cn",
            Name: "enable_constraint_optimization",
            Value: "off",
        },
        {
            Type: "dn",
            Name: "enable_constraint_optimization",
            Value: "off",
        },
    }
	request.Body = &model.ConfigurationParameterValues{
		Configurations: listConfigurationsbody,
	}
	response, err := client.UpdateConfiguration(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For more SDK sample codes of programming languages, visit API Explorer and click the Sample Code tab. Example codes can be automatically generated.

Status Code

Status Code

Description

200

The cluster parameter settings are modified successfully.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

The service was unavailable.