Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying Custom Scale-Up Policies of a Serverless Instance
Updated on 2026-01-05 GMT+08:00

Querying Custom Scale-Up Policies of a Serverless Instance

Function

This API is used to query custom scale-up policies of a serverless instance. Before calling this API:

Constraints

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

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:getScalingPolicy

    Read

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:serverless:getScalingPolicy

    -

URI

GET /v3/{project_id}/instances/{instance_id}/serverless/scaling-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.

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

enlarge_step_size

String

Definition

Custom scale-up increment.

Constraints

N/A

Range

The value is between 2 and half of the maximum compute.

Default Value

N/A

custom_scaling_config

CustomScalingConfig object

Definition

Custom scale-up policy.

Constraints

N/A

Table 4 CustomScalingConfig

Parameter

Type

Description

enlarge_scene

ScalingScene object

Definition

Custom scale-up policy.

Constraints

N/A

Table 5 ScalingScene

Parameter

Type

Description

conditions

Array of ScalingCondition objects

Definition

Configuration change conditions.

Constraints

N/A

Table 6 ScalingCondition

Parameter

Type

Description

condition_id

String

Definition

Name of a configuration change condition.

Constraints

N/A

Range

The value cannot be empty and contains a maximum of 32 characters. Only letters, digits, and hyphens (-) are allowed.

Default Value

N/A

duration

Integer

Definition

Duration, in milliseconds.

Constraints

N/A

Range

2000–5000

Default Value

N/A

interval

Integer

Definition

Interval, in milliseconds.

Constraints

N/A

Range

1000–5000

Default Value

N/A

metric_conditions

Array of MetricCondition objects

Definition

Conditions for metric reconfiguration.

Constraints

N/A

Table 7 MetricCondition

Parameter

Type

Description

metric_name

String

Definition

Metric name.

Constraints

N/A

Range

  • cpuTotalUsage: CPU usage

  • memoryTotalUsage: memory usage

Default Value

N/A

metric_value

Integer

Definition

Threshold for metric reconfiguration.

Constraints

The value is 10,000 times the percentage. For example, when the percentage is 50%, the value is 5000.

Range

6000–8000

Default Value

N/A

compare_mode

String

Definition

Comparison mode.

Constraints

N/A

Range

GT: greater than

Default Value

N/A

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying custom scale-up policies of a serverless instance

GET https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/c70a7eed50b14ee4969449ab5166aa7bin07/serverless/scaling-policy

Example Response

Status code: 200

Success.

{
  "enlarge_step_size" : "2",
  "custom_scaling_config" : {
    "enlarge_scene" : {
      "conditions" : [ {
        "condition_id" : "enlarge-custom-01",
        "metric_conditions" : [ {
          "metric_name" : "cpuTotalUsage",
          "metric_value" : 8000,
          "compare_mode" : "GT"
        } ],
        "duration" : 3000,
        "interval" : 1000
      }, {
        "condition_id" : "enlarge-custom-02",
        "metric_conditions" : [ {
          "metric_name" : "cpuTotalUsage",
          "metric_value" : 6000,
          "compare_mode" : "GT"
        } ],
        "duration" : 5000,
        "interval" : 2000
      }, {
        "condition_id" : "enlarge-custom-03",
        "metric_conditions" : [ {
          "metric_name" : "memoryTotalUsage",
          "metric_value" : 8000,
          "compare_mode" : "GT"
        } ],
        "duration" : 3000,
        "interval" : 2000
      } ]
    }
  }
}

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
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 ShowServerlessScalingPolicySolution {

    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();
        ShowServerlessScalingPolicyRequest request = new ShowServerlessScalingPolicyRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowServerlessScalingPolicyResponse response = client.showServerlessScalingPolicy(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
# 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 = ShowServerlessScalingPolicyRequest()
        request.instance_id = "{instance_id}"
        response = client.show_serverless_scaling_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)
 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
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.ShowServerlessScalingPolicyRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowServerlessScalingPolicy(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.