全部產品
Search

搜尋本產品

    Serverless App Engine：DescribeApplicationScalingRule - 查詢應用的單個Auto Scaling策略

    文件中心

    Serverless App Engine：DescribeApplicationScalingRule - 查詢應用的單個Auto Scaling策略

    更新時間：Apr 23, 2026

    s介面查詢應用的單個Auto Scaling策略。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    sae:DescribeApplicationScalingRule

    get

    *全部資源

    *

    		 無 無

    請求文法

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    是

    應用 ID。

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

    string

    是

    Auto Scaling策略名稱稱。

    test

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回資訊。

    RequestId

    string

    請求 ID。

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

    string

    調用鏈 ID，用於精確查詢調用資訊。

    0b57ff7e16243300839193068e****
    Data

    object

    返回結果。

    Timer

    object

    定時Auto Scaling。

    EndDate

    string

    定時Auto Scaling策略的短期結束日期。取值說明如下：

    • 當 BeginDate 和 EndDate 取值均為 null 時，表示長期執行，為預設值。

    • 當取值為具體日期時，例如 BeginDate 為2021-03-25，EndDate 為2021-04-25，表示執行有效期間為 1 個月。

    2021-04-25
    BeginDate

    string

    定時Auto Scaling策略的短期起始日期。取值說明如下：

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

    目標執行個體數。

    2
    MinReplicas

    integer

    最小執行個體數。

    1
    MaxReplicas

    integer

    最大執行個體數。

    10
    Period

    string

    執行定時Auto Scaling策略的周期。取值說明如下：

    • * * *：每天指定時間執行定時策略。

    • * * Fri,Mon：每周指定天數的指定時間執行定時策略，支援多選，GMT+8 時區。取值說明如下：

      • Sun：星期日

      • Mon：星期一

      • Tue：星期二

      • Wed：星期三

      • Thu：星期四

      • Fri：星期五

      • Sat：星期六

    • 1,2,3,28,31 * *：每月指定日期的指定時間執行定時策略，支援多選。取值範圍[1,31]。若當月無 31 日，則跳過該日期執行定時策略。

    * * *
    UpdateTime

    integer

    Auto Scaling策略更新時間。單位：毫秒。

    1624330075827
    AppId

    string

    應用 ID。

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

    integer

    Auto Scaling策略建立時間。單位：毫秒。

    1624329843790
    LastDisableTime

    integer

    最近一次禁用Auto Scaling策略的時間。

    1641882854484
    ScaleRuleEnabled

    boolean

    Auto Scaling策略是否啟用。取值說明如下：

    • true：啟用狀態。

    • false：禁用狀態。

    true
    ScaleRuleType

    string

    Auto Scaling策略類型。取值說明如下：

    • timing：定時彈性。

    • metric：監控指標彈性。

    • mix：混合彈性。

    timing
    Metric

    object

    監控指標Auto Scaling。

    Metrics

    array<object>

    監控指標Auto Scaling列表。

    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
    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_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
    NextScaleMetrics

    array<object>

    下一次監控指標彈性列表。

    object

    監控指標資料。

    NextScaleOutAverageUtilization

    integer

    下一次觸發擴容條件的監控指標彈性的百分比數值。

    21
    NextScaleInAverageUtilization

    integer

    下一次觸發縮容條件的監控指標彈性的百分比數值。

    10
    Name

    string

    觸發條件的名稱。

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

    string

    Auto Scaling策略名稱稱。

    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": "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": 1,
    "MinReadyInstanceRatio": -1
  },
  "Message": "success",
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。