アプリケーションの Auto Scaling ポリシーについて説明します。
今すぐお試しください
テスト
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 |
短期的なスケジュールされたスケーリングポリシーの終了日です。以下のルールが適用されます:
|
2021-04-25 |
| BeginDate |
string |
短期的なスケジュールされたスケーリングポリシーの開始日です。以下のルールが適用されます:
|
2021-03-25 |
| Schedules |
array<object> |
ポリシーの毎日のトリガースケジュールです。 |
|
|
object |
特定のトリガー時間と、その目標インスタンス数です。 |
||
| AtTime |
string |
トリガー時間です。フォーマットは |
08:00 |
| TargetReplicas |
integer |
目標インスタンス数です。 |
3 |
| MaxReplicas |
integer |
最大インスタンス数です。 |
50 |
| MinReplicas |
integer |
最小インスタンス数です。 |
1 |
| Period |
string |
スケジュールされたスケーリングポリシーが実行される曜日です。有効な値:
|
* * * |
| TimeZone |
string |
タイムゾーンです。 |
|
| UpdateTime |
integer |
ポリシーが最後に更新されたときのタイムスタンプです。単位はミリ秒です。 |
1616642248938 |
| AppId |
string |
アプリケーション ID です。 |
7171a6ca-d1cd-4928-8642-7d5cfe69**** |
| CreateTime |
integer |
ポリシーが作成されたときのタイムスタンプです。単位はミリ秒です。 |
1616642248938 |
| LastDisableTime |
integer |
ポリシーが最後に無効化されたときのタイムスタンプです。 |
1641882854484 |
| ScaleRuleEnabled |
boolean |
Auto Scaling ポリシーが有効かどうかを示します。有効な値:
|
true |
| ScaleRuleType |
string |
Auto Scaling ポリシーのタイプです。有効な値:
|
timing |
| Metric |
object |
メトリクスベースのスケーリングポリシーです。 |
|
| Metrics |
array<object> |
スケーリングをトリガーするメトリクスベースの条件です。 |
|
|
object |
スケーリングイベントをトリガーできるメトリック条件です。 |
||
| MetricTargetAverageUtilization |
integer |
メトリックの目標値です。単位は
|
20 |
| MetricType |
string |
Auto Scaling ポリシーをトリガーするために使用されるメトリックです。有効な値:
|
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 |
データの型です。このパラメーターは指定されたメトリックに関連付けられています。
|
Resource |
| CurrentValue |
integer |
現在の値です。 |
0 |
| Name |
string |
トリガー条件の名前です。
|
cpu |
| NextScaleMetrics |
array<object> |
次のスケーリングアクティビティのためのメトリクスのリストです。 |
|
|
object |
メトリックデータです。 |
||
| NextScaleOutAverageUtilization |
integer |
次のスケールアウトイベントをトリガーするメトリック値です。値はパーセンテージです。 |
21 |
| NextScaleInAverageUtilization |
integer |
次のスケールインイベントをトリガーするメトリック値です。値はパーセンテージです。 |
10 |
| Name |
string |
トリガー条件の名前です。
|
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 |
スケールアウトを無効にするかどうかを指定します。有効な値:
説明
このパラメーターを |
false |
| ScaleDownRules |
object |
スケールインイベントの設定です。 |
|
| Step |
integer |
1 回のスケールインイベントで削除するインスタンス数です。 |
100 |
| StabilizationWindowSeconds |
integer |
スケールインイベントのクールダウン時間です (秒単位)。この期間中、それ以上のスケーリングイベントはトリガーされません。値は 0 から 3,600 までの整数である必要があります。デフォルト値は 0 です。 |
300 |
| Disabled |
boolean |
スケールインを無効にするかどうかを指定します。有効な値:
説明
これを |
false |
| MetricSource |
string |
メトリックのソースです。 |
|
| PrometheusUrl |
string |
Prometheus サービスのエンドポイントです。 |
|
| PrometheusToken |
string |
Prometheus トークンです。 |
|
| ScaleRuleName |
string |
Auto Scaling ポリシーの名前です。 |
test |
| MinReadyInstances |
integer |
利用可能な最小インスタンス数です。有効な値:
説明
ローリングデプロイ中の業務継続性を確保するために、このパラメーターを 1 以上の値に設定することを推奨します。 |
1 |
| MinReadyInstanceRatio |
integer |
利用可能な最小インスタンス数をパーセンテージで指定します。有効な値:
説明
MinReadyInstances と MinReadyInstanceRatio の両方を指定した場合、MinReadyInstanceRatio が -1 に設定されていない限り、MinReadyInstanceRatio の値が優先されます。 |
-1 |
| Message |
string |
応答メッセージです。有効な値:
|
success |
| ErrorCode |
string |
エラーコードです。このパラメーターは、リクエストが失敗した場合にのみ返されます。
|
|
| Code |
string |
HTTP ステータスコードです。有効な値:
|
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。