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

Enabling Auto Throttling

Function

This API is used to enable auto throttling. Before calling this API:

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:instance:setSqlFilterRules

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:param:modify

    -

URI

PUT /v3/{project_id}/instances/{instance_id}/auto-sql-limiting

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

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us

Table 3 Request body parameter

Parameter

Mandatory

Type

Description

auto_sql_limiting_rules

Yes

Array of AutoSqlLimitingRule objects

Definition

Enable auto throttling rules.

Constraints

N/A

Table 4 AutoSqlLimitingRule

Parameter

Mandatory

Type

Description

node_id

Yes

String

Definition

Node ID.

To obtain this value, see Querying Details of a DB Instance.

Constraints

The node role must be the primary node.

Range

The value contains 36 characters, starting with a UUID and ending with no07. Only letters and digits are allowed.

Default Value

N/A

start_time

Yes

String

Definition

Time when the daily validity period of an auto throttling rule starts.

Constraints

The value is in hh:mm format.

Range

N/A

Default Value

N/A

end_time

Yes

String

Definition

Time when the daily validity period of an auto throttling rule ends.

Constraints

The value is in hh:mm format.

Range

N/A

Default Value

N/A

condition

Yes

String

Definition

Association between the CPU usage and the number of active sessions in the throttling policy.

Constraints

N/A

Range

  • and

  • or

Default Value

N/A

cpu_usage

Yes

Integer

Definition

CPU usage specified in the throttling policy.

Constraints

N/A

Range

70–100

Default Value

N/A

active_sessions

Yes

Integer

Definition

Number of active sessions specified in the throttling policy.

Constraints

N/A

Range

1–5000

Default Value

N/A

clear_time

Yes

Integer

Definition

Maximum throttling duration each time (minutes).

Constraints

N/A

Range

1–1440

Default Value

N/A

duration

Yes

Integer

Definition

Duration (minutes) of events that meet auto throttling criteria.

Constraints

N/A

Range

2–60

Default Value

N/A

max_concurrency

Yes

Integer

Definition

Maximum number of concurrent requests.

Constraints

N/A

Range

0–1000000000

Default Value

N/A

retain_sql_rule

Yes

Boolean

Definition

Whether to retain existing SQL throttling rules.

Constraints

N/A

Range

  • true: Existing SQL throttling rules are retained.

  • false: Existing SQL throttling rules are cleared.

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameter

Parameter

Type

Description

job_id

String

Definition

ID of the task for enabling auto throttling.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Enabling auto throttling

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/auto-sql-limiting

{
  "auto_sql_limiting_rules" : [ {
    "node_id" : "a4e0f43f6ee2459fa3ac27474cb5991cno07",
    "start_time" : "00:00",
    "end_time" : "01:01",
    "condition" : "and",
    "cpu_usage" : 70,
    "active_sessions" : 3,
    "duration" : 2,
    "clear_time" : 3,
    "max_concurrency" : 1000,
    "retain_sql_rule" : true
  } ]
}

Example Response

Status code: 200

Success.

{
  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
}

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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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 SetAutoSqlLimitingSolution {

    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();
        SetAutoSqlLimitingRequest request = new SetAutoSqlLimitingRequest();
        request.withInstanceId("{instance_id}");
        SetAutoSqlLimitingReq body = new SetAutoSqlLimitingReq();
        List<AutoSqlLimitingRule> listbodyAutoSqlLimitingRules = new ArrayList<>();
        listbodyAutoSqlLimitingRules.add(
            new AutoSqlLimitingRule()
                .withNodeId("a4e0f43f6ee2459fa3ac27474cb5991cno07")
                .withStartTime("00:00")
                .withEndTime("01:01")
                .withCondition("and")
                .withCpuUsage(70)
                .withActiveSessions(3)
                .withClearTime(3)
                .withDuration(2)
                .withMaxConcurrency(1000)
                .withRetainSqlRule(true)
        );
        body.withAutoSqlLimitingRules(listbodyAutoSqlLimitingRules);
        request.withBody(body);
        try {
            SetAutoSqlLimitingResponse response = client.setAutoSqlLimiting(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
45
46
47
48
49
# 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 = SetAutoSqlLimitingRequest()
        request.instance_id = "{instance_id}"
        listAutoSqlLimitingRulesbody = [
            AutoSqlLimitingRule(
                node_id="a4e0f43f6ee2459fa3ac27474cb5991cno07",
                start_time="00:00",
                end_time="01:01",
                condition="and",
                cpu_usage=70,
                active_sessions=3,
                clear_time=3,
                duration=2,
                max_concurrency=1000,
                retain_sql_rule=True
            )
        ]
        request.body = SetAutoSqlLimitingReq(
            auto_sql_limiting_rules=listAutoSqlLimitingRulesbody
        )
        response = client.set_auto_sql_limiting(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
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := gaussdb.NewGaussDBClient(
        gaussdb.GaussDBClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.SetAutoSqlLimitingRequest{}
	request.InstanceId = "{instance_id}"
	var listAutoSqlLimitingRulesbody = []model.AutoSqlLimitingRule{
        {
            NodeId: "a4e0f43f6ee2459fa3ac27474cb5991cno07",
            StartTime: "00:00",
            EndTime: "01:01",
            Condition: "and",
            CpuUsage: int32(70),
            ActiveSessions: int32(3),
            ClearTime: int32(3),
            Duration: int32(2),
            MaxConcurrency: int32(1000),
            RetainSqlRule: true,
        },
    }
	request.Body = &model.SetAutoSqlLimitingReq{
		AutoSqlLimitingRules: listAutoSqlLimitingRulesbody,
	}
	response, err := client.SetAutoSqlLimiting(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.