DescribeApplicationScalingRules - 查询应用弹性伸缩策略 - Serverless 应用引擎

查询应用弹性伸缩策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sae:DescribeApplicationScalingRules

get

*全部资源

*

无

请求语法

GET /pop/v1/sam/scale/applicationScalingRules HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****

返回参数

名称	类型	描述	示例值
	object	返回信息。
RequestId	string	请求 ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
TraceId	string	调用链 ID，用于精确查询调用信息。	0a98a02315955564772843261e****
Data	object	返回结果。
CurrentPage	integer	当前页数。	1
TotalSize	integer	应用弹性伸缩策略总数。	3
PageSize	integer	页面大小。	10
ApplicationScalingRules	array<object>	应用弹性伸缩策略列表。
	array<object>	应用弹性伸缩策略。
Timer	object	定时弹性伸缩。
EndDate	string	定时弹性伸缩策略的短期结束日期。取值说明如下：当 BeginDate 和 EndDate 取值均为 null 时，表示长期执行，为默认值。当取值为具体日期时，例如 BeginDate 为 2021-03-25，EndDate 为 2021-04-25，表示执行有效期为 1 个月。	2021-04-25
BeginDate	string	定时弹性伸缩策略的短期起始日期。取值说明如下：当 BeginDate 和 EndDate 取值均为 null 时，表示长期执行，为默认值。当取值为具体日期时，例如 BeginDate 为 2021-03-25，EndDate 为 2021-04-25，表示执行有效期为 1 个月。	2021-03-25
Schedules	array<object>	单天内触发时间点。
	object	时间点数据。
AtTime	string	时间点。格式：时:分。	08:00
TargetReplicas	integer	目标实例数。	3
MaxReplicas	integer	最大实例数。	50
MinReplicas	integer	最小实例数。	1
Period	string	执行定时弹性伸缩策略的周期。取值说明如下： *** * **：每天指定时间执行定时策略。 * Fri,Mon：每周指定天数的指定时间执行定时策略，支持多选，GMT+8 时区。取值说明如下： Sun：星期日 Mon：星期一 Tue：星期二 Wed：星期三 Thu：星期四 Fri：星期五 Sat：星期六 1,2,3,28,31 * *：每月指定日期的指定时间执行定时策略，支持多选。取值范围[1,31]。若当月无 31 日，则跳过该日期执行定时策略。	* * *
TimeZone	string
UpdateTime	integer	弹性伸缩策略更新时间。单位：毫秒。	1616642248938
AppId	string	应用 ID。	7171a6ca-d1cd-4928-8642-7d5cfe69****
CreateTime	integer	弹性伸缩策略创建时间。单位：毫秒。	1616642248938
LastDisableTime	integer	最近一次禁用弹性伸缩策略的时间。	1641882854484
ScaleRuleEnabled	boolean	弹性伸缩策略是否启用。取值说明如下： true：启用状态。 false：禁用状态。	true
ScaleRuleType	string	弹性伸缩策略类型。取值说明如下： timing：定时弹性。 metric：监控指标弹性。 mix：混合弹性。	timing
Metric	object	监控指标弹性伸缩。
Metrics	array<object>	监控指标弹性伸缩列表。
	object	监控指标数据。
MetricTargetAverageUtilization	integer	监控指标的目标值。 CPU 使用率目标值，单位为百分比。内存使用率目标值，单位为百分比。 QPS，单位为秒。响应时间，单位为毫秒。 TCP 活跃连接数平均值，单位为个/秒。公网 SLB QPS，单位为秒。公网 SLB 响应时间，单位为毫秒。私网 SLB QPS，单位为秒。私网 SLB 响应时间，单位为毫秒。	20
MetricType	string	监控指标的触发条件。取值说明如下： CPU：CPU 使用率。 MEMORY：内存使用率。 QPS：JAVA 应用 1 分钟内单个实例的平均 QPS。 RT：JAVA 应用 1 分钟内应用所有服务接口平均 RT 值。 tcpActiveConn：30 秒内单个实例的平均 TCP 活跃连接数。 SLB_QPS：15 秒内单个实例的平均公网 SLB QPS。 SLB_RT：15 秒内公网 SLB 平均响应时间。 INTRANET_SLB_QPS：15 秒内单个实例的平均私网 SLB QPS。 INTRANET_SLB_RT：15 秒内私网 SLB 平均响应时间。	CPU
SlbProject	string	SLB 访问日志 Project。	test
SlbLogstore	string	SLB 访问日志 Logstore。	test
Vport	string	SLB 实例端口。	80
SlbId	string	SLB 实例 ID。	lb-xxx
PrometheusMetrics	array<object>
	object
PrometheusQuery	string
TargetMetricValue	string
MetricsStatus	object	监控指标弹性状态。
DesiredReplicas	integer	目标实例数。	2
NextScaleTimePeriod	integer	下一次监控指标弹性的周期。	3
CurrentReplicas	integer	当前实例数。	2
LastScaleTime	string	最近一次弹性扩缩的时间。	2022-01-11T08:14:32Z
CurrentMetrics	array<object>	当前监控指标弹性列表。
	object	监控指标数据。
Type	string	数据类型。与监控指标关联。 Resource：cpu、memory 的指标取值。 Pods：tcpActiveConn 的指标取值。 External：arms、slb 的指标取值。	Resource
CurrentValue	integer	当前值。	0
Name	string	触发条件的名称。 cpu：CPU 使用率。 memory：内存使用率。 arms_incall_qps_v2：Java 应用 QPS。 arms_incall_rt：Java 应用响应时间。 tcpActiveConn：TCP 活跃连接数。 slb_incall_qps：公网 SLB QPS。 slb_incall_rt：公网 SLB 响应时间。 intranet_slb_incall_qps：私网 SLB QPS。 intranet_slb_incall_rt：私网 SLB 响应时间。	cpu
NextScaleMetrics	array<object>	下一次监控指标弹性列表。
	object	监控指标数据。
NextScaleOutAverageUtilization	integer	下一次触发扩容条件的监控指标弹性的百分比数值。	21
NextScaleInAverageUtilization	integer	下一次触发缩容条件的监控指标弹性的百分比数值。	10
Name	string	触发条件的名称。 cpu：CPU 使用率。 memory：内存使用率。 arms_incall_qps_v2：JAVA 应用 QPS。 arms_incall_rt：AVA 应用响应时间。 tcpActiveConn：TCP 活跃连接数。 slb_incall_qps：公网 SLB QPS。 slb_incall_rt：公网 SLB 响应时间。 intranet_slb_incall_qps：私网 SLB QPS。 intranet_slb_incall_rt：私网 SLB 响应时间。	cpu
MaxReplicas	integer	最大实例数。	3
MinReplicas	integer	最小实例数。	1
MaxReplicas	integer	最大实例数。	3
MinReplicas	integer	最小实例数。	1
ScaleUpRules	object	应用扩容规则。
Step	integer	弹性扩容步长。单位时间内最多扩容的实例数。	100
StabilizationWindowSeconds	integer	扩容冷却时间。取值范围[0, 3600]，单位为秒。默认为 0 秒。	300
Disabled	boolean	是否禁止缩容。取值说明如下： true：开启。 false：关闭。说明开启后将永远不会缩容该应用的实例，能有效防止在流量高峰期缩容造成业务风险。默认关闭。	false
ScaleDownRules	object	应用缩容规则。
Step	integer	弹性缩容步长。单位时间内最多缩容的实例数。	100
StabilizationWindowSeconds	integer	缩容冷却时间。取值范围[0, 3600]，单位为秒。默认为 0 秒。	300
Disabled	boolean	是否禁止缩容。取值说明如下： true：开启。 false：关闭。说明开启后将永远不会缩容该应用的实例，能有效防止在流量高峰期缩容造成业务风险。默认关闭。	false
MetricSource	string
PrometheusUrl	string
PrometheusToken	string
ScaleRuleName	string	弹性伸缩策略名称。	test
MinReadyInstances	integer	最小存活实例数。取值说明如下：如果设置为 0，应用在升级过程中将会中断业务。如果设置为-1，最小存活实例数将使用系统推荐值，即取现有实例数的 25%。如果当前为 5 个实例，5×25%=1.25，向上取整后，最小存活实例数为 2。说明每次滚动部署最小存活的实例数建议≥1，保证业务不中断。	1
MinReadyInstanceRatio	integer	最小存活实例数百分比。取值说明如下： -1：初始化值，表示不采用百分比。 0~100：单位为百分比，向上取整。例如设置为 50%，如果当前为 5 个实例，则最小存活实例数为 3。说明当和 MinReadyInstanceRatio 同时传递时，且 MinReadyInstanceRatio 的取值非-1时，以 MinReadyInstanceRatio 参数为准。假设 MinReadyInstances 取值为 5，MinReadyInstanceRatio 取值为 50，则会用 50 来计算最小存活实例数。	-1
Message	string	附加信息。取值说明如下：请求正常，返回 success。请求异常，返回具体异常错误码。	success
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	重启应用实例是否成功。取值说明如下： true：重启成功。 false：重启失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 3,
    "PageSize": 10,
    "ApplicationScalingRules": [
      {
        "Timer": {
          "EndDate": "2021-04-25",
          "BeginDate": "2021-03-25",
          "Schedules": [
            {
              "AtTime": "08:00",
              "TargetReplicas": 3,
              "MaxReplicas": 50,
              "MinReplicas": 1
            }
          ],
          "Period": "* * *",
          "TimeZone": ""
        },
        "UpdateTime": 1616642248938,
        "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
        "CreateTime": 1616642248938,
        "LastDisableTime": 1641882854484,
        "ScaleRuleEnabled": true,
        "ScaleRuleType": "timing",
        "Metric": {
          "Metrics": [
            {
              "MetricTargetAverageUtilization": 20,
              "MetricType": "CPU",
              "SlbProject": "test",
              "SlbLogstore": "test",
              "Vport": "80",
              "SlbId": "lb-xxx"
            }
          ],
          "PrometheusMetrics": [
            {
              "PrometheusQuery": "",
              "TargetMetricValue": ""
            }
          ],
          "MetricsStatus": {
            "DesiredReplicas": 2,
            "NextScaleTimePeriod": 3,
            "CurrentReplicas": 2,
            "LastScaleTime": "2022-01-11T08:14:32Z",
            "CurrentMetrics": [
              {
                "Type": "Resource",
                "CurrentValue": 0,
                "Name": "cpu"
              }
            ],
            "NextScaleMetrics": [
              {
                "NextScaleOutAverageUtilization": 21,
                "NextScaleInAverageUtilization": 10,
                "Name": "cpu"
              }
            ],
            "MaxReplicas": 3,
            "MinReplicas": 1
          },
          "MaxReplicas": 3,
          "MinReplicas": 1,
          "ScaleUpRules": {
            "Step": 100,
            "StabilizationWindowSeconds": 300,
            "Disabled": false
          },
          "ScaleDownRules": {
            "Step": 100,
            "StabilizationWindowSeconds": 300,
            "Disabled": false
          },
          "MetricSource": "",
          "PrometheusUrl": "",
          "PrometheusToken": ""
        },
        "ScaleRuleName": "test",
        "MinReadyInstances": 1,
        "MinReadyInstanceRatio": -1
      }
    ]
  },
  "Message": "success",
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。