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

Serverless App Engine:DescribeApplicationScalingRule

最終更新日:Apr 22, 2026

アプリケーションの単一のオートスケーリングポリシーについて説明します。

今すぐお試しください

この 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:DescribeApplicationScalingRule

get

*All Resource

*

なし なし

リクエスト構文

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

AppId

string

必須

アプリケーション ID。

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

ScalingRuleName

string

必須

オートスケーリングポリシーの名前。

test

レスポンスフィールド

フィールド

説明

object

返される情報。

RequestId

string

リクエスト ID。

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

TraceId

string

トレース ID。この ID を使用して、リクエストの詳細を照会できます。

0b57ff7e16243300839193068e****

Data

object

返されたデータ。

Timer

object

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

EndDate

string

短期的なスケジュールされたスケーリングポリシーの終了日。有効な値は次のとおりです:

  • BeginDateEndDate の両方を空のままにした場合、ポリシーは長期ポリシーになります。これはデフォルト値です。

  • 日付を指定した場合、たとえば BeginDate2021-03-25 に、EndDate2021-04-25 に設定すると、ポリシーは 1 か月間有効になります。

2021-04-25

BeginDate

string

短期的なスケジュールされたスケーリングポリシーの開始日。有効な値は次のとおりです:

  • BeginDateEndDate の両方を空のままにした場合、ポリシーは長期ポリシーになります。これはデフォルト値です。

  • 日付を指定した場合、たとえば BeginDate2021-03-25 に、EndDate2021-04-25 に設定すると、ポリシーは 1 か月間有効になります。

2021-03-25

Schedules

array<object>

1 日のうち、オートスケーリングポリシーがトリガーされる時点。

object

時点のデータ。

AtTime

string

時点。形式:HH:mm

08:00

TargetReplicas

integer

ターゲットインスタンス数。

2

MinReplicas

integer

最小インスタンス数。

1

MaxReplicas

integer

最大インスタンス数。

10

Period

string

スケジュールされたスケーリングポリシーが実行される期間。有効な値:

  • * * *:ポリシーは毎日指定された時刻に実行されます。

  • * * Fri,Mon:ポリシーは週の 1 日または複数日の指定された時刻に実行されます。複数の曜日を選択できます。時刻は GMT+8 です。有効な値:

    • Sun:日曜日

    • Mon:月曜日

    • Tue:火曜日

    • Wed:水曜日

    • Thu:木曜日

    • Fri:金曜日

    • Sat:土曜日

  • 1,2,3,28,31 * *:ポリシーは月の 1 日または複数日の指定された時刻に実行されます。複数の日を選択できます。値は 1 から 31 までの整数です。月に 31 日目がない場合、その日にはポリシーは実行されません。

* * *

UpdateTime

integer

オートスケーリングポリシーが更新された時刻。単位:ミリ秒。

1624330075827

AppId

string

アプリケーション ID。

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

CreateTime

integer

オートスケーリングポリシーが作成された時刻。単位:ミリ秒。

1624329843790

LastDisableTime

integer

オートスケーリングポリシーが最後に無効化された時刻。

1641882854484

ScaleRuleEnabled

boolean

オートスケーリングポリシーが有効になっているかどうかを示します。有効な値:

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

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

true

ScaleRuleType

string

オートスケーリングポリシーのタイプ。有効な値:

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

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

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

timing

Metric

object

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

Metrics

array<object>

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

object

メトリクスデータ。

MetricTargetAverageUtilization

integer

メトリクスのターゲット値。

  • ターゲット CPU 使用率。単位:パーセント。

  • ターゲットメモリ使用量。単位:パーセント。

  • 秒間クエリ数 (QPS)。

  • 応答時間。単位:ミリ秒。

  • 1 秒あたりの平均アクティブ TCP 接続数。

  • パブリック向け SLB インスタンスの QPS。

  • パブリック向け SLB インスタンスの応答時間。単位:ミリ秒。

  • プライベート SLB インスタンスの QPS。

  • プライベート SLB インスタンスの応答時間。単位:ミリ秒。

20

MetricType

string

オートスケーリングポリシーをトリガーするために使用されるメトリクス。有効な値:

  • CPU:CPU 使用率。

  • MEMORY:メモリ使用量。

  • QPS:1 分間の Java アプリケーションの単一インスタンスの平均 QPS。

  • RT:1 分間の Java アプリケーションのすべてのサービスインターフェイスの平均レスポンスタイム (RT)。

  • tcpActiveConn:30 秒間の単一インスタンスの平均アクティブ TCP 接続数。

  • SLB_QPS:15 秒間のパブリック向け SLB インスタンスの単一インスタンスの平均 QPS。

  • SLB_RT:15 秒間のパブリック向け SLB インスタンスの平均 RT。

  • INTRANET_SLB_QPS:15 秒間のプライベート SLB インスタンスの単一インスタンスの平均 QPS。

  • INTRANET_SLB_RT:15 秒間のプライベート SLB インスタンスの平均 RT。

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

メトリクスのタイプ。このパラメーターはモニタリングメトリクスに関連付けられています。

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

  • PodstcpActiveConn のメトリクス値。

  • Externalarms または slb のメトリクス値。

Resource

CurrentValue

integer

現在の値。

0

Name

string

メトリクスの名前。

  • cpu:CPU 使用率。

  • memory:メモリ使用量。

  • arms_incall_qps:1 分間の Java アプリケーションの単一インスタンスの平均 QPS。

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

  • tcpActiveConn:アクティブな TCP 接続数。

  • slb_incall_qps:パブリック向け SLB インスタンスの QPS。

  • slb_incall_rt:パブリック向け SLB インスタンスの RT。

  • intranet_slb_incall_qps:プライベート SLB インスタンスの QPS。

  • intranet_slb_incall_rt:プライベート SLB インスタンスの RT。

cpu

NextScaleMetrics

array<object>

次のスケーリングアクティビティのメトリクスのリスト。

object

メトリクスデータ。

NextScaleOutAverageUtilization

integer

次のスケールアウトのメトリクスしきい値。値はパーセンテージです。

21

NextScaleInAverageUtilization

integer

次のスケールインのメトリクスしきい値。値はパーセンテージです。

10

Name

string

メトリクスの名前。

  • cpu:CPU 使用率。

  • memory:メモリ使用量。

  • arms_incall_qps:1 分間の Java アプリケーションの単一インスタンスの平均 QPS。

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

  • tcpActiveConn:アクティブな TCP 接続数。

  • slb_incall_qps:パブリック向け SLB インスタンスの QPS。

  • slb_incall_rt:パブリック向け SLB インスタンスの RT。

  • intranet_slb_incall_qps:プライベート SLB インスタンスの QPS。

  • intranet_slb_incall_rt:プライベート SLB インスタンスの RT。

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

オートスケーリングポリシーの名前。

test

MinReadyInstances

integer

準備完了状態の最小インスタンス数。有効な値:

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

  • このパラメーターを -1 に設定すると、システムは準備完了状態の最小インスタンス数の推奨値を使用します。この値は現在のインスタンス数の 25% です。例えば、現在のインスタンス数が 5 の場合、5 × 25% = 1.25 を切り上げた後、準備完了状態の最小インスタンス数は 2 になります。

説明

業務継続性を確保するために、各ローリングデプロイで準備完了状態の最小インスタンス数を 1 以上に設定してください。

1

MinReadyInstanceRatio

integer

準備完了状態の最小インスタンス数のパーセンテージ。有効な値:

  • -1:初期値。パーセンテージが使用されないことを示します。

  • 0 から 100:切り上げられるパーセンテージ。たとえば、このパラメーターを 50% に設定し、現在のインスタンス数が 5 の場合、準備完了状態の最小インスタンス数は 3 になります。

説明

MinReadyInstances と MinReadyInstanceRatio の両方を指定し、MinReadyInstanceRatio の値が -1 でない場合、MinReadyInstanceRatio の値が優先されます。たとえば、MinReadyInstances5 に設定され、MinReadyInstanceRatio50 に設定されている場合、準備完了状態の最小インスタンス数の計算には値 50 が使用されます。

-1

Message

string

追加情報。有効な値:

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

  • リクエストが失敗した場合、特定のエラーコードが返されます。

success

ErrorCode

string

エラーコード。有効な値:

  • リクエストが成功した場合、ErrorCode フィールドは返されません。

  • リクエストが失敗した場合、ErrorCode フィールドが返されます。詳細については、このトピックの「エラーコード」セクションをご参照ください。

Code

string

HTTP ステータスコードまたは POP エラーコード。有効な値:

  • 2xx:操作は成功しました。

  • 3xx:リダイレクトが必要です。

  • 4xx:リクエストエラーが発生しました。

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

200

Success

boolean

アプリケーションインスタンスの再起動が成功したかどうかを示します。

  • true:再起動が成功したことを示します。

  • false:再起動が失敗したことを示します。

true

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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