更新时间:2024-12-16 GMT+08:00
分享

设置自动变配

功能介绍

设置自动变配。

接口约束

该接口目前公测阶段,如需使用,请提交工单联系客服人员申请权限。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/instances/{instance_id}/auto-scaling/policy

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

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

instance_id

String

实例ID,严格匹配UUID规则。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

Content-Type

String

内容类型。

取值:application/json。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us

  • zh-cn

表3 请求Body参数

参数

是否必选

参数类型

描述

status

String

自动变配开关状态。

取值:

  • ON:开启。

  • OFF:关闭。

scaling_strategy

ScalingStrategyReqInfo object

自动变配策略。

monitor_cycle

Integer

监测周期(单位:秒)。

在整个观测窗口期内,若CPU平均使用率大于等于设定值,则在观测窗口结束后,进行扩容。

取值范围:300、600、900、1800。

status为ON时必填。

silence_cycle

Integer

静默周期(单位:秒)。

两次自动扩容或自动回缩的最小间隔时间。

取值范围:300、600、1800、3600、7200、10800、86400、604800。

status为ON时必填。

enlarge_threshold

Integer

CPU平均使用率(百分比数值)。

取值范围:50-100。

status为ON时必填。

max_flavor

String

扩容规格上限。开启扩缩规格时必填。

reduce_enabled

Boolean

是否开启自动回缩。开启自动变配时必填。

  • true:是。

  • false:否。

max_read_only_count

Integer

只读节点数量上限。开启增删只读节点时必填。

read_only_weight

Integer

只读节点读写分离权重。开启增删只读节点时必填。

表4 ScalingStrategyReqInfo

参数

是否必选

参数类型

描述

flavor_switch

String

扩缩规格开关。

  • ON:开启。

  • OFF:关闭。

read_only_switch

String

增删只读节点开关。自动增删只读节点功能需要先开启数据库代理,且只能有一个代理。

  • ON:开启。

  • OFF:关闭。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

instance_id

String

实例ID。

instance_name

String

实例名称。

switch_status

AutoScalingSwitchStatus object

开关状态。

表6 AutoScalingSwitchStatus

参数

参数类型

描述

scaling_switch

String

自动变配开关状态。

取值:

  • ON:开启。

  • OFF:关闭。

flavor_switch

String

扩缩规格开关状态。

取值:

  • ON:开启。

  • OFF:关闭。

read_only_switch

String

增删只读节点开关状态。

取值:

  • ON:开启。

  • OFF:关闭。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

设置自动变配。

PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy

{
  "enlarge_threshold" : 50,
  "max_flavor" : "gaussdb.mysql.large.x86.4",
  "max_read_only_count" : 2,
  "monitor_cycle" : 300,
  "read_only_weight" : 10,
  "reduce_enabled" : false,
  "scaling_strategy" : {
    "flavor_switch" : "ON",
    "read_only_switch" : "ON"
  },
  "silence_cycle" : 300,
  "status" : "ON"
}

响应示例

状态码: 200

Success.

{
  "instance_id" : "61a4ea66210545909d74a05c27a7179ein07",
  "instance_name" : "gauss-test-1",
  "switch_status" : {
    "scaling_switch" : "ON",
    "flavor_switch" : "ON",
    "read_only_switch" : "ON"
  }
}

SDK代码示例

SDK代码示例如下。

Java

设置自动变配。

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

    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();
        UpdateAutoScalingPolicyRequest request = new UpdateAutoScalingPolicyRequest();
        request.withInstanceId("{instance_id}");
        UpdateAutoScalingPolicyRequestBody body = new UpdateAutoScalingPolicyRequestBody();
        ScalingStrategyReqInfo scalingStrategybody = new ScalingStrategyReqInfo();
        scalingStrategybody.withFlavorSwitch("ON")
            .withReadOnlySwitch("ON");
        body.withScalingStrategy(scalingStrategybody);
        body.withReadOnlyWeight(10);
        body.withMaxReadOnlyCount(2);
        body.withReduceEnabled(false);
        body.withMaxFlavor("gaussdb.mysql.large.x86.4");
        body.withEnlargeThreshold(50);
        body.withSilenceCycle(300);
        body.withMonitorCycle(300);
        body.withStatus("ON");
        request.withBody(body);
        try {
            UpdateAutoScalingPolicyResponse response = client.updateAutoScalingPolicy(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());
        }
    }
}

Python

设置自动变配。

 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
# 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 = UpdateAutoScalingPolicyRequest()
        request.instance_id = "{instance_id}"
        scalingStrategybody = ScalingStrategyReqInfo(
            flavor_switch="ON",
            read_only_switch="ON"
        )
        request.body = UpdateAutoScalingPolicyRequestBody(
            scaling_strategy=scalingStrategybody,
            read_only_weight=10,
            max_read_only_count=2,
            reduce_enabled=False,
            max_flavor="gaussdb.mysql.large.x86.4",
            enlarge_threshold=50,
            silence_cycle=300,
            monitor_cycle=300,
            status="ON"
        )
        response = client.update_auto_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)

Go

设置自动变配。

 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
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.UpdateAutoScalingPolicyRequest{}
	request.InstanceId = "{instance_id}"
	scalingStrategybody := &model.ScalingStrategyReqInfo{
		FlavorSwitch: "ON",
		ReadOnlySwitch: "ON",
	}
	readOnlyWeightUpdateAutoScalingPolicyRequestBody:= int32(10)
	maxReadOnlyCountUpdateAutoScalingPolicyRequestBody:= int32(2)
	reduceEnabledUpdateAutoScalingPolicyRequestBody:= false
	maxFlavorUpdateAutoScalingPolicyRequestBody:= "gaussdb.mysql.large.x86.4"
	enlargeThresholdUpdateAutoScalingPolicyRequestBody:= int32(50)
	silenceCycleUpdateAutoScalingPolicyRequestBody:= int32(300)
	monitorCycleUpdateAutoScalingPolicyRequestBody:= int32(300)
	request.Body = &model.UpdateAutoScalingPolicyRequestBody{
		ScalingStrategy: scalingStrategybody,
		ReadOnlyWeight: &readOnlyWeightUpdateAutoScalingPolicyRequestBody,
		MaxReadOnlyCount: &maxReadOnlyCountUpdateAutoScalingPolicyRequestBody,
		ReduceEnabled: &reduceEnabledUpdateAutoScalingPolicyRequestBody,
		MaxFlavor: &maxFlavorUpdateAutoScalingPolicyRequestBody,
		EnlargeThreshold: &enlargeThresholdUpdateAutoScalingPolicyRequestBody,
		SilenceCycle: &silenceCycleUpdateAutoScalingPolicyRequestBody,
		MonitorCycle: &monitorCycleUpdateAutoScalingPolicyRequestBody,
		Status: "ON",
	}
	response, err := client.UpdateAutoScalingPolicy(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.

错误码

请参见错误码

相关文档