DescribeApplicationScalingRule - DescribeApplicationScalingRule

调用DescribeApplicationScalingRules接口查询应用的单个弹性伸缩策略。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sae:DescribeApplicationScalingRuleget
  • 全部资源
    *

请求语法

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

请求参数

名称类型必填描述示例值
AppIdstring

应用 ID。

a0d2e04c-159d-40a8-b240-d2f2c263****
ScalingRuleNamestring

弹性伸缩策略名称。

test

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求 ID。

73404D3D-EE4F-4CB2-B197-5C46F6A1****
TraceIdstring

调用链 ID,用于精确查询调用信息。

0b57ff7e16243300839193068e****
Dataobject

返回结果。

Timerobject

定时弹性伸缩。

EndDatestring

定时弹性伸缩策略的短期结束日期。取值说明如下:

  • BeginDateEndDate 取值均为 null 时,表示长期执行,为默认值。
  • 当取值为具体日期时,例如 BeginDate2021-03-25EndDate2021-04-25,表示执行有效期为 1 个月。
2021-04-25
BeginDatestring

定时弹性伸缩策略的短期起始日期。取值说明如下:

  • BeginDateEndDate 取值均为 null 时,表示长期执行,为默认值。
  • 当取值为具体日期时,例如 BeginDate2021-03-25EndDate2021-04-25,表示执行有效期为 1 个月。
2021-03-25
Schedulesarray<object>

单天内触发时间点。

Scheduleobject

时间点数据。

AtTimestring

时间点。格式:时:分

08:00
TargetReplicasinteger

目标实例数。

2
MinReplicasinteger

最小实例数。

1
MaxReplicasinteger

最大实例数。

10
Periodstring

执行定时弹性伸缩策略的周期。取值说明如下:

  • * * *:每天指定时间执行定时策略。

  • * * Fri,Mon:每周指定天数的指定时间执行定时策略,支持多选,GMT+8 时区。取值说明如下:

    • Sun:星期日
    • Mon:星期一
    • Tue:星期二
    • Wed:星期三
    • Thu:星期四
    • Fri:星期五
    • Sat:星期六
  • 1,2,3,28,31 * *:每月指定日期的指定时间执行定时策略,支持多选。取值范围[1,31]。若当月无 31 日,则跳过该日期执行定时策略。

* * *
UpdateTimelong

弹性伸缩策略更新时间。单位:毫秒。

1624330075827
AppIdstring

应用 ID。

a0d2e04c-159d-40a8-b240-d2f2c263****
CreateTimelong

弹性伸缩策略创建时间。单位:毫秒。

1624329843790
LastDisableTimelong

最近一次禁用弹性伸缩策略的时间。

1641882854484
ScaleRuleEnabledboolean

弹性伸缩策略是否启用。取值说明如下:

  • true:启用状态。
  • false:禁用状态。
true
ScaleRuleTypestring

弹性伸缩策略类型。取值说明如下:

  • timing:定时弹性。
  • metric:监控指标弹性。
  • mix:混合弹性。
timing
Metricobject

监控指标弹性伸缩。

Metricsarray<object>

监控指标弹性伸缩列表。

Metricobject

监控指标数据。

MetricTargetAverageUtilizationinteger

监控指标的目标值。

  • CPU 使用率目标值,单位为百分比。
  • 内存使用率目标值,单位为百分比。
  • QPS,单位为秒。
  • 响应时间,单位为毫秒。
  • TCP 活跃连接数平均值,单位为个/秒。
  • 公网 SLB QPS,单位为秒。
  • 公网 SLB 响应时间,单位为毫秒。
  • 私网 SLB QPS,单位为秒。
  • 私网 SLB 响应时间,单位为毫秒。
20
MetricTypestring

监控指标的触发条件。取值说明如下:

  • 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
SlbProjectstring

SLB 访问日志 Project。

test
SlbLogstorestring

SLB 访问日志 Logstore。

test
Vportstring

SLB 实例端口。

80
SlbIdstring

SLB 实例 ID。

lb-xxx
MetricsStatusobject

监控指标弹性状态。

DesiredReplicaslong

目标实例数。

2
NextScaleTimePeriodinteger

下一次监控指标弹性的周期。

3
CurrentReplicaslong

当前实例数。

2
LastScaleTimestring

最近一次弹性扩缩的时间。

2022-01-11T08:14:32Z
CurrentMetricsarray<object>

当前监控指标弹性数据。

CurrentMetricobject

监控指标数据。

Typestring

数据类型。与监控指标关联。

  • Resourcecpumemory 的指标取值。
  • PodstcpActiveConn 的指标取值。
  • Externalarmsslb 的指标取值。
Resource
CurrentValuelong

当前值。

0
Namestring

触发条件的名称。

  • cpu:CPU 使用率。
  • memory:内存使用率。
  • arms_incall_rt:JAVA 应用 1 分钟内单个实例的平均 QPS。
  • arms_incall_rt:JAVA 应用 1 分钟内应用所有服务接口平均 RT 值。
  • tcpActiveConn:TCP 活跃连接数。
  • slb_incall_qps:公网 SLB QPS。
  • slb_incall_rt:公网 SLB 响应时间。
  • intranet_slb_incall_qps:私网 SLB QPS。
  • intranet_slb_incall_rt:私网 SLB 响应时间。
cpu
NextScaleMetricsarray<object>

下一次监控指标弹性列表。

NextScaleMetricobject

监控指标数据。

NextScaleOutAverageUtilizationinteger

下一次触发扩容条件的监控指标弹性的百分比数值。

21
NextScaleInAverageUtilizationinteger

下一次触发缩容条件的监控指标弹性的百分比数值。

10
Namestring

触发条件的名称。

  • cpu:CPU 使用率。
  • memory:内存使用率。
  • arms_incall_rt:JAVA 应用 1 分钟内单个实例的平均 QPS。
  • arms_incall_rt:JAVA 应用 1 分钟内应用所有服务接口平均 RT 值。
  • tcpActiveConn:TCP 活跃连接数。
  • slb_incall_qps:公网 SLB QPS。
  • slb_incall_rt:公网 SLB 响应时间。
  • intranet_slb_incall_qps:私网 SLB QPS。
  • intranet_slb_incall_rt:私网 SLB 响应时间。
cpu
MaxReplicasinteger

最大实例数。

3
MinReplicasinteger

最小实例数。

1
ScaleUpRulesobject

应用扩容规则。

Steplong

弹性扩容步长。单位时间内最多扩容的实例数。

100
StabilizationWindowSecondslong

扩容冷却时间。取值范围[0, 3600],单位为秒。默认为 0 秒。

300
Disabledboolean

是否禁止缩容。取值说明如下:

  • true:开启。
  • false:关闭。
说明 开启后将永远不会缩容该应用的实例,能有效防止在流量高峰期缩容造成业务风险。默认关闭。
false
ScaleDownRulesobject

应用缩容规则。

Steplong

弹性缩容步长。单位时间内最多缩容的实例数。

100
StabilizationWindowSecondslong

缩容冷却时间。取值范围[0, 3600],单位为秒。默认为 0 秒。

300
Disabledboolean

是否禁止缩容。取值说明如下:

  • true:开启。
  • false:关闭。
说明 开启后将永远不会缩容该应用的实例,能有效防止在流量高峰期缩容造成业务风险。默认关闭。
false
ScaleRuleNamestring

弹性伸缩策略名称。

test
Messagestring

附加信息。取值说明如下:

  • 请求正常,返回 success
  • 请求异常,返回具体异常错误码。
success
ErrorCodestring

错误码。取值说明如下:

  • 请求成功:不返回 ErrorCode 字段。
  • 请求失败:返回 ErrorCode 字段。具体信息,请参见本文的错误码列表。
Codestring

接口状态或 POP 错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
200
Successboolean

重启应用实例是否成功。取值说明如下:

  • true:重启成功。
  • false:重启失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "73404D3D-EE4F-4CB2-B197-5C46F6A1****",
  "TraceId": "0b57ff7e16243300839193068e****",
  "Data": {
    "Timer": {
      "EndDate": "2021-04-25",
      "BeginDate": "2021-03-25",
      "Schedules": [
        {
          "AtTime": "08:00",
          "TargetReplicas": 2,
          "MinReplicas": 1,
          "MaxReplicas": 10
        }
      ],
      "Period": "* * *"
    },
    "UpdateTime": 1624330075827,
    "AppId": "a0d2e04c-159d-40a8-b240-d2f2c263****",
    "CreateTime": 1624329843790,
    "LastDisableTime": 1641882854484,
    "ScaleRuleEnabled": true,
    "ScaleRuleType": "timing",
    "Metric": {
      "Metrics": [
        {
          "MetricTargetAverageUtilization": 20,
          "MetricType": "CPU",
          "SlbProject": "test",
          "SlbLogstore": "test",
          "Vport": "80",
          "SlbId": "lb-xxx"
        }
      ],
      "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,
      "ScaleUpRules": {
        "Step": 100,
        "StabilizationWindowSeconds": 300,
        "Disabled": false
      },
      "ScaleDownRules": {
        "Step": 100,
        "StabilizationWindowSeconds": 300,
        "Disabled": false
      }
    },
    "ScaleRuleName": "test",
    "MinReadyInstances": 0,
    "MinReadyInstanceRatio": 0,
    "EnableIdle": true
  },
  "Message": "success",
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-30OpenAPI 返回结构发生变更查看变更详情
2023-05-31OpenAPI 返回结构发生变更查看变更详情
2023-05-24OpenAPI 返回结构发生变更查看变更详情
2022-12-19OpenAPI 返回结构发生变更查看变更详情