文档首页/ 云数据库 TaurusDB/ API参考/ API/ 参数模板管理/ 更新自定义参数模板 - UpgradeConfiguration
更新时间:2026-09-08 GMT+08:00
分享

更新自定义参数模板 - UpgradeConfiguration

功能介绍

更新自定义参数模板,将模板参数值同步为系统默认模板的值,包含规格参数值。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbformysql:param:update

    Write

    -

    -

    gaussdb:param:modify

    -

URI

PUT /v3/{project_id}/configurations/{configuration_id}/upgrade

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

获取方法请参见获取项目ID

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

configuration_id

String

参数解释

参数模板ID,此参数是参数模板的唯一标识。

获取方法请参见查询参数模板

约束限制

不涉及。

取值范围

只能由英文字母、数字组成,长度为36个字符。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。 通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认取值

application/json。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us:英文。

  • zh-cn:中文。

默认取值

en-us。

表3 请求Body参数

参数

是否必选

参数类型

描述

parameters

Array of strings

参数解释

需要更新的差异参数名称列表。

  • 若参数有值传入:将该参数更新为系统默认模板的值。

  • 若参数传入空值或未传入:保留自定义模板中的原有值。

约束限制

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

name

String

参数解释

参数模板名称。

取值范围

不涉及。

diff_parameters

Array of GroupParameterDiffInfo objects

参数解释

差异参数列表。

skipped_parameter_names

Array of strings

参数解释

执行更新操作被跳过的参数名称列表(原值与目标值相同)。

表5 GroupParameterDiffInfo

参数

参数类型

描述

name

String

参数解释

参数名称。

取值范围

不涉及。

source_value

String

参数解释

源参数值(当前模板中的值)。

取值范围

不涉及。

target_value

String

参数解释

目标参数值(系统默认模板中的值)。

取值范围

不涉及。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

更新自定义模板。

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/configurations/61a4ea66210545909d74a05c27a7179fin07/upgrade

{
  "parameters" : [ "max_connections", "innodb_buffer_pool_size" ]
}

响应示例

状态码:200

Success.

{
  "name" : "paramTemplate-test",
  "diff_parameters" : [ {
    "name" : "max_connections",
    "source_value" : "100",
    "target_value" : "200"
  } ],
  "skipped_parameter_names" : [ "innodb_buffer_pool_size" ]
}

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
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.gaussdb.v3.region.GaussDBRegion;
import com.huaweicloud.sdk.gaussdb.v3.*;
import com.huaweicloud.sdk.gaussdb.v3.model.*;

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

public class UpgradeConfigurationSolution {

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

        GaussDBClient client = GaussDBClient.newBuilder()
                .withCredential(auth)
                .withRegion(GaussDBRegion.valueOf("<YOUR REGION>"))
                .build();
        UpgradeConfigurationRequest request = new UpgradeConfigurationRequest();
        request.withConfigurationId("{configuration_id}");
        UpgradeConfigurationRequestBody body = new UpgradeConfigurationRequestBody();
        List<String> listbodyParameters = new ArrayList<>();
        listbodyParameters.add("max_connections");
        listbodyParameters.add("innodb_buffer_pool_size");
        body.withParameters(listbodyParameters);
        request.withBody(body);
        try {
            UpgradeConfigurationResponse response = client.upgradeConfiguration(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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkgaussdb.v3.region.gaussdb_region import GaussDBRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkgaussdb.v3 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 = GaussDBClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(GaussDBRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpgradeConfigurationRequest()
        request.configuration_id = "{configuration_id}"
        listParametersbody = [
            "max_connections",
            "innodb_buffer_pool_size"
        ]
        request.body = UpgradeConfigurationRequestBody(
            parameters=listParametersbody
        )
        response = client.upgrade_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
51
52
53
54
55
56
57
package main

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


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

    client := gaussdb.NewGaussDBClient(hcClient)

    request := &model.UpgradeConfigurationRequest{}
	request.ConfigurationId = "{configuration_id}"
	var listParametersbody = []string{
        "max_connections",
	    "innodb_buffer_pool_size",
    }
	request.Body = &model.UpgradeConfigurationRequestBody{
		Parameters: &listParametersbody,
	}
	response, err := client.UpgradeConfiguration(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码

相关文档