You need to enable JavaScript to run this app.
导航
弹性伸缩
  • 文档首页
    • /
  • 弹性伸缩

DescribeScalingPolicies - 查询伸缩规则列表

最近更新时间：2024.05.21 17:43:40

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

我的收藏

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

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

DescribeScalingPolicies

要执行的操作，取值：DescribeScalingPolicies。

Version
String
是

2020-01-01

API的版本，取值：2020-01-01。

ScalingGroupId
String
是

scg-ybmssdnnhn5pkgyd****

伸缩组的ID。您可以调用DescribeScalingGroups查询伸缩组ID。

ScalingPolicyIds.N
Array of String
否

sp-ybmvamf8uql8j1fl****

伸缩规则的ID列表。

  • 参数 - N：表示伸缩规则的序号，取值：1～10。
PageNumber
Integer
否

1

伸缩规则列表的页码，默认值：1。

PageSize
Integer
否

10

分页查询时设置的每页行数，取值：1 ～ 100。
默认值：10。

ScalingPolicyNames.N
Array of String
否

test-1

伸缩规则的名称列表。

  • 参数 - N：表示伸缩规则的序号，取值：1～10。
ScalingPolicyType
String
否

Scheduled

伸缩规则的类型，取值：

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
PageNumber
Integer

1

当前页数。

PageSize
Integer

10

当前分页的行数。

ScalingPolicies
Array of ScalingPolicy

--

符合条件的伸缩规则信息。

TotalCount
Integer

20

符合条件的伸缩规则总数。

请求示例

GET /?Action=DescribeScalingPolicies&ScalingGroupId=scg-ybmssdnnhn5pkgyd****&Version=2020-01-01 HTTP/1.1
Host: open.volcengineapi.com
X-Date: 20240507T111034Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240507/cn-beijing/auto_scaling/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240507191044074190125159D96104",
    "Version": "2020-01-01",
    "Service": "auto_scaling",
    "Region": "cn-beijing"
  },
  "Result": {
    "PageNumber": 1,
    "PageSize": 10,
    "ScalingPolicies": [
      {
        "ScalingGroupId": "scg-ybmssdnnhn5pkgyd****",
        "ScalingPolicyId": "sp-ybmvamf8uql8j1fl****",
        "ScalingPolicyName": "test-1",
        "AlarmPolicy": {
          "EvaluationCount": 3,
          "RuleType": "Static",
          "Condition": {
            "Threshold": "10",
            "MetricUnit": "Percent",
            "MetricName": "CpuTotal_Max",
            "ComparisonOperator": ">"
          }
        },
        "AdjustmentValue": 1,
        "Cooldown": 60,
        "ScalingPolicyType": "Scheduled",
        "ScheduledPolicy": {
          "LaunchTime": "2022-04-01T16:00Z",
          "RecurrenceEndTime": "2022-04-02T16:00Z",
          "RecurrenceValue": "3",
          "RecurrenceType": "Daily",
          "RecurrenceStartTime": "2022-04-01T16:00Z"
        },
        "AdjustmentType": "QuantityChangeInCapacity",
        "Status": "Active"
      },
    ],
    "TotalCount": 20
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。