すべてのプロダクト
Search
ドキュメントセンター

Serverless App Engine:DescribeApplicationScalingRules

最終更新日:Apr 22, 2026

アプリケーションの Auto Scaling ポリシーについて説明します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeApplicationScalingRules

get

*All Resource

*

なし なし

リクエスト構文

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

アプリケーションの Auto Scaling ポリシーの総数です。

3

PageSize

integer

1 ページあたりのエントリ数です。

10

ApplicationScalingRules

array<object>

アプリケーションの Auto Scaling ポリシーのリストです。

array<object>

Auto Scaling ポリシーです。

Timer

object

スケジュールされたスケーリングポリシーです。

EndDate

string

短期的なスケジュールされたスケーリングポリシーの終了日です。以下のルールが適用されます:

  • BeginDateEndDate が指定されていない場合、ポリシーはデフォルトで長期間有効になります。

  • BeginDateEndDate を指定した場合、ポリシーは短期的であり、その期間内でのみ適用されます。

2021-04-25

BeginDate

string

短期的なスケジュールされたスケーリングポリシーの開始日です。以下のルールが適用されます:

  • BeginDateEndDate が指定されていない場合、ポリシーはデフォルトで長期間有効になります。

  • BeginDateEndDate を指定した場合、ポリシーは短期的であり、その期間内でのみ適用されます。

2021-03-25

Schedules

array<object>

ポリシーの毎日のトリガースケジュールです。

object

特定のトリガー時間と、その目標インスタンス数です。

AtTime

string

トリガー時間です。フォーマットは HH:mm です。

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

Auto Scaling ポリシーが有効かどうかを示します。有効な値:

  • true:ポリシーは有効です。

  • false:ポリシーは無効です。

true

ScaleRuleType

string

Auto Scaling ポリシーのタイプです。有効な値:

  • timing:スケジュールされたスケーリングポリシー。

  • metric:メトリクスベースのスケーリングポリシー。

  • mix:ハイブリッドスケーリングポリシー。

timing

Metric

object

メトリクスベースのスケーリングポリシーです。

Metrics

array<object>

スケーリングをトリガーするメトリクスベースの条件です。

object

スケーリングイベントをトリガーできるメトリック条件です。

MetricTargetAverageUtilization

integer

メトリックの目標値です。単位は MetricType の値によって異なります。

  • ターゲット CPU 使用率 (%)。

  • ターゲットメモリ使用量 (%)。

  • ターゲット QPS (秒間クエリ数)。

  • ターゲット応答時間 (ミリ秒)。

  • ターゲットアクティブ TCP 接続数。

  • パブリック SLB インスタンスのターゲット QPS (秒間クエリ数)。

  • パブリック SLB インスタンスのターゲット応答時間 (ミリ秒)。

  • プライベート SLB インスタンスのターゲット QPS (秒間クエリ数)。

  • プライベート SLB インスタンスのターゲット応答時間 (ミリ秒)。

20

MetricType

string

Auto Scaling ポリシーをトリガーするために使用されるメトリックです。有効な値:

  • CPU:CPU 使用率。

  • MEMORY:メモリ使用量。

  • QPS:1 分間のインスタンスあたりの平均秒間クエリ数 (QPS)。このメトリックは Java アプリケーションにのみ適用されます。

  • RT:1 分間の Java アプリケーション内のすべてのサービスインターフェイスの平均応答時間。

  • 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 アクセスログを格納する Log Service のプロジェクトです。

test

SlbLogstore

string

SLB アクセスログを格納する Log Service の Logstore です。

test

Vport

string

SLB インスタンスの監視対象ポートです。

80

SlbId

string

SLB インスタンスの ID です。

lb-xxx

PrometheusMetrics

array<object>

Prometheus メトリクスです。

object

PrometheusQuery

string

Prometheus クエリです。

TargetMetricValue

string

スケーリングイベントをトリガーする Prometheus クエリの目標値です。

MetricsStatus

object

メトリクスベースのスケーリングポリシーのステータスです。

DesiredReplicas

integer

目標インスタンス数です。

2

NextScaleTimePeriod

integer

メトリクスベースのスケーリングの次の期間です。

3

CurrentReplicas

integer

現在のインスタンス数です。

2

LastScaleTime

string

最後のスケーリングアクティビティの時間です。

2022-01-11T08:14:32Z

CurrentMetrics

array<object>

スケーリングのための現在のメトリクスのリストです。

object

メトリックデータです。

Type

string

データの型です。このパラメーターは指定されたメトリックに関連付けられています。

  • Resourcecpu または memory のメトリック値。

  • PodstcpActiveConn のメトリック値。

  • Externalarms または 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:Java アプリケーションの応答時間。

  • 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

1 回のスケールアウトイベントで追加するインスタンス数です。

100

StabilizationWindowSeconds

integer

スケールアウトイベントのクールダウン時間です (秒単位)。この期間中、それ以上のスケーリングイベントはトリガーされません。値は 0 から 3,600 までの整数である必要があります。デフォルト値は 0 です。

300

Disabled

boolean

スケールアウトを無効にするかどうかを指定します。有効な値:

  • true:スケールアウトを無効にします。

  • false:スケールアウトを有効にします。

説明

このパラメーターを true に設定すると、アプリケーションインスタンスはスケールアウトされません。これは、特定のイベント中にアプリケーションのキャパシティをフリーズさせるのに役立ちます。デフォルトでは、このパラメーターは false に設定されています。

false

ScaleDownRules

object

スケールインイベントの設定です。

Step

integer

1 回のスケールインイベントで削除するインスタンス数です。

100

StabilizationWindowSeconds

integer

スケールインイベントのクールダウン時間です (秒単位)。この期間中、それ以上のスケーリングイベントはトリガーされません。値は 0 から 3,600 までの整数である必要があります。デフォルト値は 0 です。

300

Disabled

boolean

スケールインを無効にするかどうかを指定します。有効な値:

  • true:スケールインを無効にします。

  • false:スケールインを有効にします。

説明

これを true に設定すると、アプリケーションのスケールインが防止されます。これは、ピーク時間帯に予期しないキャパシティ削減によるサービスの中断を避けるのに役立ちます。デフォルト:false

false

MetricSource

string

メトリックのソースです。

PrometheusUrl

string

Prometheus サービスのエンドポイントです。

PrometheusToken

string

Prometheus トークンです。

ScaleRuleName

string

Auto Scaling ポリシーの名前です。

test

MinReadyInstances

integer

利用可能な最小インスタンス数です。有効な値:

  • このパラメーターを 0 に設定すると、アップグレード中にアプリケーションが中断される可能性があります。

  • このパラメーターを -1 に設定すると、推奨値が使用されます。これは、現在のインスタンス数の 25% を最も近い整数に切り上げた値です。たとえば、アプリケーションに 5 つのインスタンスがある場合、利用可能な最小インスタンス数は 2 (5 * 25% = 1.25、切り上げ) です。

説明

ローリングデプロイ中の業務継続性を確保するために、このパラメーターを 1 以上の値に設定することを推奨します。

1

MinReadyInstanceRatio

integer

利用可能な最小インスタンス数をパーセンテージで指定します。有効な値:

  • -1:このパラメーターが使用されないことを示します。

  • 0 から 100:最も近い整数に切り上げられるパーセンテージ。たとえば、このパラメーターを 50% に設定し、5 つのインスタンスがある場合、利用可能な最小インスタンス数は 3 です。

説明

MinReadyInstances と MinReadyInstanceRatio の両方を指定した場合、MinReadyInstanceRatio-1 に設定されていない限り、MinReadyInstanceRatio の値が優先されます。

-1

Message

string

応答メッセージです。有効な値:

  • リクエストが成功した場合、success を返します。

  • リクエストが失敗した場合、エラーメッセージを返します。

success

ErrorCode

string

エラーコードです。このパラメーターは、リクエストが失敗した場合にのみ返されます。

  • 詳細については、このトピックのエラーコードセクションをご参照ください。

Code

string

HTTP ステータスコードです。有効な値:

  • 2xx:リクエストは成功しました。

  • 3xx:リクエストはリダイレクトされました。

  • 4xx:リクエストは無効でした。

  • 5xx:サーバーエラーが発生しました。

200

Success

boolean

リクエストが成功したかどうかを示します。有効な値:

  • true:呼び出しは成功しました。

  • false:呼び出しは失敗しました。

true

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。