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

查询自动变配

功能介绍

查询自动变配。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

租户在某一Region下的project ID。

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

约束限制

不涉及。

取值范围

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

默认值

不涉及。

instance_id

String

参数解释

实例ID,此参数是实例的唯一标识。

约束限制

不涉及。

取值范围

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。

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

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

约束限制

不涉及。

取值范围

不涉及。

默认值

不涉及。

Content-Type

String

参数解释

内容类型。

约束限制

不涉及。

取值范围

application/json。

默认值

不涉及。

X-Language

String

参数解释

请求语言类型。

约束限制

不涉及。

取值范围

  • en-us

  • zh-cn

默认值

en-us。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

自动变配策略ID。

取值范围

不涉及。

instance_id

String

参数解释

实例ID。

取值范围

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

instance_name

String

参数解释

实例名称。

取值范围

最小为4个字符,最大为64个字符且不超过64个字节(注意:一个中文字符占用3个字节),必须以字母或中文开头,区分大小写,可以包含字母、数字、中划线、下划线或中文,不能包含其他特殊字符。

status

String

参数解释

自动变配开关状态。

取值范围

  • ON:已开启。

  • OFF:已关闭。

monitor_cycle

Integer

参数解释

监测周期(单位:秒)。

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

取值范围

  • 300

  • 600

  • 900

  • 1800

silence_cycle

Integer

参数解释

静默周期(单位:秒)。

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

取值范围

  • 300

  • 600

  • 1800

  • 3600

  • 7200

  • 10800

  • 86400

  • 604800

enlarge_threshold

Integer

参数解释

扩容阈值(百分比数值),指CPU平均使用率。

取值范围

50-100

max_flavor

String

参数解释

扩容规格上限。

取值范围

当前局点该实例能规格变更的上限。

reduce_enabled

Boolean

参数解释

自动回缩开关状态。

取值范围

  • true:已开启

  • false:已关闭

min_flavor

String

参数解释

缩容规格下限。

取值范围

当前局点该实例能规格变更的下限。

silence_start_at

String

参数解释

静默期开始时间(上一次变更结束时间)。

格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

取值范围

不涉及。

scaling_strategy

ScalingStrategyInfo object

参数解释

自动变配策略。

max_read_only_count

Integer

参数解释

只读节点数量上限。

取值范围

2≤当前备节点数<设定值≤15

min_read_only_count

Integer

参数解释

只读节点数量下限。

取值范围

1-14

read_only_weight

Integer

参数解释

只读节点读写分离权重。

取值范围

0-1000

表4 ScalingStrategyInfo

参数

参数类型

描述

flavor_switch

String

参数解释

扩缩规格开关。

取值范围

  • ON:开启。

  • OFF:关闭。

read_only_switch

String

参数解释

增删只读节点开关。

取值范围

  • ON:开启。

  • OFF:关闭。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询自动变配。

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

响应示例

状态码: 200

Success.

  • 自动变配开启时查询自动变配。

    {
      "id" : "26d8e193-1ea0-4adb-89d0-d1343399d0e7",
      "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07",
      "instance_name" : "gauss-test-1",
      "status" : "ON",
      "monitor_cycle" : 300,
      "silence_cycle" : 300,
      "enlarge_threshold" : 50,
      "max_flavor" : "gaussdb.mysql.large.x86.4",
      "reduce_enabled" : false,
      "min_flavor" : "gaussdb.mysql.medium.x86.4",
      "silence_start_at" : "2023-08-31T08:59:09+0000",
      "scaling_strategy" : {
        "flavor_switch" : "ON",
        "read_only_switch" : "ON"
      },
      "max_read_only_count" : 2,
      "min_read_only_count" : 1,
      "read_only_weight" : 10
    }
  • 自动变配关闭时查询自动变配。

    {
      "id" : null,
      "instance_id" : "41ff7519e22d44eea6066615fa5b17c7in07",
      "instance_name" : "gauss-test-1",
      "status" : "OFF",
      "monitor_cycle" : null,
      "silence_cycle" : null,
      "enlarge_threshold" : null,
      "max_flavor" : null,
      "reduce_enabled" : null,
      "min_flavor" : null,
      "silence_start_at" : "",
      "scaling_strategy" : {
        "flavor_switch" : "",
        "read_only_switch" : ""
      },
      "max_read_only_count" : null,
      "min_read_only_count" : null,
      "read_only_weight" : null
    }

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

    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();
        ShowAutoScalingPolicyRequest request = new ShowAutoScalingPolicyRequest();
        request.withInstanceId("{instance_id}");
        try {
            ShowAutoScalingPolicyResponse response = client.showAutoScalingPolicy(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
# 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 = ShowAutoScalingPolicyRequest()
        request.instance_id = "{instance_id}"
        response = client.show_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
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.ShowAutoScalingPolicyRequest{}
	request.InstanceId = "{instance_id}"
	response, err := client.ShowAutoScalingPolicy(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.

错误码

请参见错误码

相关文档