You need to enable JavaScript to run this app.
导航

DescribeScalingPolicies

最近更新时间2024.01.16 14:13:13

首次发布时间2022.05.13 10:42:45

调用 DescribeScalingPolicies 查询伸缩规则。如果不存在匹配的伸缩规则,则自动忽略,继续查询其他伸缩规则。

请求参数

名字类型是否必填示例值
描述
ActionStringDescribeScalingPolicies要执行的操作。取值:DescribeScalingPolicies。
VersionString2020-01-01API的版本,取值为:2020-01-01。
PageNumberInteger1伸缩规则列表的页码,默认值:1。

PageSize

Integer

10

分页查询时设置的每页行数,取值:1 ~ 50。
默认值:10。

ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。

ScalingPolicyType

String

Scheduled

伸缩规则的类型,取值:

  • Scheduled:定时任务。
  • Recurrence:周期任务。
  • Alarm:报警任务。

ScalingPolicyIds.N

String

ScalingPolicyIds.1=sp-ybmvamf8uql8j1fl****&
ScalingPolicyIds.2=sp-ybl9nky62vgso055****

伸缩规则的ID。

  • 参数 - N:表示伸缩规则的序号,取值:1~10。

ScalingPolicyNames.N

String

ScalingPolicyNames.1=test-1&
ScalingPolicyNames.2=test-2

伸缩规则的名称。

  • 参数 - N:表示伸缩规则的序号,取值:1~10。

返回数据

名字类型示例值
描述
PageNumberInteger1当前页数。
PageSizeInteger10当前分页的行数。
TotalCountInteger20符合条件的伸缩规则总数。
ScalingPoliciesArray of struct-符合条件的伸缩规则信息。具体请参见下表“ScalingPolicy结构”。

ScalingPolicy结构

名字类型示例值
描述
ScalingGroupIdStringscg-ybmssdnnhn5pkgyd****伸缩规则所属的伸缩组的ID。
ScalingPolicyIdStringsp-ybmvamf8uql8j1fl****伸缩规则的ID。
ScalingPolicyNameStringtest-1伸缩规则的名称。

ScalingPolicyType

String

Scheduled

伸缩规则的类型,取值:

  • Scheduled:定时任务。
  • Recurrence:周期任务。
  • Alarm:报警任务。
ScheduledPolicyStruct--定时任务/周期任务的详细信息。具体请参见下表“ScheduledPolicy结构”。

AlarmPolicy

Struct

--

报警任务的详细信息。具体请参见下表“AlarmPolicy结构”。

AdjustmentType

String

QuantityChangeInCapacity

伸缩规则的伸缩行为, 适用于简单规则和步进规则,取值:

  • QuantityChangeInCapacity:增加或减少指定数量的实例。
  • PercentChangeInCapacity:增加或减少指定比例的实例。
  • TotalCapacity: 将当前伸缩组的实例数量调整到指定数量。
AdjustmentValueInteger1伸缩行为的调整数值。
CooldownInteger60伸缩规则的冷却时间,单位:s。

Status

String

Active

伸缩规则的状态。取值:

  • Active:已启用。
  • InActive:已停用。

ScheduledPolicy结构

名字类型示例值
描述

LaunchTime

String

2022-04-01T16:00Z

表示任务的触发时间,默认为此刻。

  • ScalingPolicyType值为Scheduled时,表示定时任务的触发时间。
  • ScalingPolicyType值为Recurrence时:
    • 如果ScheduledPolicy.RecurrenceType为空,则表示仅按照此处指定的日期和时间执行一次。
    • 如果ScheduledPolicy.RecurrenceType不为空,则表示周期任务开始时间。

RecurrenceStartTime

String

2022-04-01T16:00Z

表示周期任务的开始执行时间。。

说明

ScalingPolicyType取值为Recurrence时有效。

RecurrenceEndTime

String

2022-04-02T16:00Z

表示周期任务的结束时间。

说明

ScalingPolicyType取值为Recurrence时有效。

RecurrenceType

String

Daily

表示周期任务的重复周期,取值:

  • Daily:每XX天执行一次。
  • Weekly:选择每周中的几天,每天执行一次。
  • Monthly:选择每月中XX号到XX号,每天执行一次。
  • Cron:按照指定的Cron表达式执行。

说明

ScalingPolicyType取值为Recurrence时有效。

RecurrenceValue

String

3

表示重复执行周期任务的数值。

说明

ScalingPolicyType取值为Recurrence时有效。

AlarmPolicy结构

名字类型示例值
描述

RuleType

String

Static

报警任务的类型,取值:

  • Static:表示由agent采集的静态监控。
EvaluationCountInteger3当监控指标数据连续几次达到阈值时,即触发伸缩行为。

Condition

Struct

--

监控指标的详细信息。具体请参见下表“Condition结构”。

说明

仅当ScalingPolicyType取值为Alarm时有效。

Condition结构

名字类型示例值
描述

MetricName

String

CpuTotal_Max

监控指标名称,取值:

  • CpuTotal_Max:带内CPU使用率最大值,表示伸缩组中所有实例CPU使用率的最大值。
  • CpuTotal_Min:带内CPU使用率最小值。
  • CpuTotal_Avg:带内CPU使用率平均值。
  • MemoryUsedUtilization_Max:带内内存使用率最大值。
  • MemoryUsedUtilization_Min::带内内存使用率最小值。
  • MemoryUsedUtilization_Avg::带内内存使用率平均值。
  • Instance_CpuBusy_Max:带外CPU利用率最大值。
  • Instance_CpuBusy_Min:带外CPU利用率最小值。
  • Instance_CpuBusy_Avg:带外CPU利用率平均值。

ComparisonOperator

String

>

规则表达式对象。

  • >:大于
  • <:小于
  • =:等于
ThresholdString10监控指标的阈值。
MetricUnitStringPercent监控指标阈值的单位。取值:Percent。

请求示例

GET /?Action=DescribeScalingPolicies&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: auto_scaling

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20220420155921010174235038031A****",
        "Action": "DescribeScalingPolicies",
        "Version": "2020-01-01",
        "Service": "auto_scaling",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "ScalingPolicies": [
            {
                "ScalingPolicyId": "sp-ybmvamf8uql8j1fl****",
                "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
                "ScalingPolicyName": "test-1",
                "ScalingPolicyType": "Scheduled",
                "ScheduledPolicy": {
                    "LaunchTime": "2022-05-17T16:50:00Z",
                    "RecurrenceStartTime": "",
                    "RecurrenceEndTime": "",
                    "RecurrenceType": "",
                    "RecurrenceValue": ""
                },
                "AdjustmentType": "TotalCapacity",
                "AdjustmentValue": 3,
                "Cooldown": 200,
                "Status": "InActive",
                "AlarmPolicy": null
            }
        ]
    }
}