Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Configuring a Dynamic Serverless Compute Policy
Updated on 2026-07-16 GMT+08:00

Configuring a Dynamic Serverless Compute Policy

Function

This API is used to configure a dynamic serverless compute policy for an instance. Before calling this API:

Constraints

This API is in the OBT phase. To use it, submit a service ticket.

Prerequisites for enabling dynamic serverless:

  • This function is only available for multi-AZ dedicated x86 instances with fixed specifications (pay-per-use or yearly/monthly).

  • This function is only available for cluster instances. It is not available for single-node, multi-primary, or serverless instances.

  • This function is only available for instances with a CPU-to-memory ratio of 1:4, where read replicas must have identical specifications to the primary node.

  • This function is only available for instances with a kernel version of 2.0.54.240600 or later and auto scaling disabled.

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 and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:serverless:updateDynamicPolicy

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:serverless:updateDynamicPolicy

    -

URI

POST /v3/{project_id}/instances/{instance_id}/serverless/dynamic-policy

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

To obtain this value, see Querying DB Instances.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us: English

  • zh-cn: Chinese

Default Value

en-us

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

min_vcpus

Yes

String

Definition

Minimum dynamic serverless compute.

Constraints

N/A

Range

The value range can be obtained from Querying a Dynamic Serverless Compute Policy. The value must be less than or equal to that of max_vcpus.

Default Value

N/A

max_vcpus

Yes

String

Definition

Maximum dynamic serverless compute.

Constraints

N/A

Range

The value range can be obtained from Querying a Dynamic Serverless Compute Policy. The value must be greater than or equal to that of min_vcpus.

Default Value

N/A

need_update_nodes_compute_ability

No

Boolean

Definition

Whether to synchronize the current compute of nodes below the minimum compute to the minimum compute when you change the compute range.

Constraints

N/A

Range

  • true: The node compute is synchronized.

  • false: The node compute is not synchronized.

Default Value

false

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for configuring dynamic serverless.

Range

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Configuring a dynamic serverless compute policy for an instance

POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/serverless/dynamic-policy

{
  "min_vcpus" : "2",
  "max_vcpus" : "32",
  "need_update_nodes_compute_ability" : true
}

Example Response

Status code: 200

Success.

  • Configuring a dynamic serverless compute policy for an instance with dynamic serverless disabled

    {
      "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
    }
  • Configuring a dynamic serverless compute policy for an instance with dynamic serverless enabled

    {
      "job_id" : null
    }

SDK Sample Code

The SDK sample code is as follows.

Configuring a dynamic serverless compute policy for an instance

 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
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.*;


public class UpdateDynamicServerlessPolicySolution {

    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();
        UpdateDynamicServerlessPolicyRequest request = new UpdateDynamicServerlessPolicyRequest();
        request.withInstanceId("{instance_id}");
        UpdateDynamicServerlessPolicyRequestBody body = new UpdateDynamicServerlessPolicyRequestBody();
        body.withNeedUpdateNodesComputeAbility(true);
        body.withMaxVcpus("32");
        body.withMinVcpus("2");
        request.withBody(body);
        try {
            UpdateDynamicServerlessPolicyResponse response = client.updateDynamicServerlessPolicy(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());
        }
    }
}

Configuring a dynamic serverless compute policy for an instance

 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
# 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 = UpdateDynamicServerlessPolicyRequest()
        request.instance_id = "{instance_id}"
        request.body = UpdateDynamicServerlessPolicyRequestBody(
            need_update_nodes_compute_ability=True,
            max_vcpus="32",
            min_vcpus="2"
        )
        response = client.update_dynamic_serverless_policy(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Configuring a dynamic serverless compute policy for an instance

 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 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.UpdateDynamicServerlessPolicyRequest{}
	request.InstanceId = "{instance_id}"
	needUpdateNodesComputeAbilityUpdateDynamicServerlessPolicyRequestBody:= true
	request.Body = &model.UpdateDynamicServerlessPolicyRequestBody{
		NeedUpdateNodesComputeAbility: &needUpdateNodesComputeAbilityUpdateDynamicServerlessPolicyRequestBody,
		MaxVcpus: "32",
		MinVcpus: "2",
	}
	response, err := client.UpdateDynamicServerlessPolicy(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 Code

For details, see Status Codes.

Error Code

For details, see Error Codes.