アプリケーションの単一のオートスケーリングポリシーについて説明します。
今すぐお試しください
テスト
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 |
短期的なスケジュールされたスケーリングポリシーの終了日。有効な値は次のとおりです:
|
2021-04-25 |
| BeginDate |
string |
短期的なスケジュールされたスケーリングポリシーの開始日。有効な値は次のとおりです:
|
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 |
スケジュールされたスケーリングポリシーが実行される期間。有効な値:
|
* * * |
| UpdateTime |
integer |
オートスケーリングポリシーが更新された時刻。単位:ミリ秒。 |
1624330075827 |
| AppId |
string |
アプリケーション ID。 |
a0d2e04c-159d-40a8-b240-d2f2c263**** |
| CreateTime |
integer |
オートスケーリングポリシーが作成された時刻。単位:ミリ秒。 |
1624329843790 |
| LastDisableTime |
integer |
オートスケーリングポリシーが最後に無効化された時刻。 |
1641882854484 |
| ScaleRuleEnabled |
boolean |
オートスケーリングポリシーが有効になっているかどうかを示します。有効な値:
|
true |
| ScaleRuleType |
string |
オートスケーリングポリシーのタイプ。有効な値:
|
timing |
| Metric |
object |
メトリクスベースのスケーリングポリシー。 |
|
| Metrics |
array<object> |
メトリクスベースのスケーリングポリシーのリスト。 |
|
|
object |
メトリクスデータ。 |
||
| MetricTargetAverageUtilization |
integer |
メトリクスのターゲット値。
|
20 |
| MetricType |
string |
オートスケーリングポリシーをトリガーするために使用されるメトリクス。有効な値:
|
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 |
| 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 |
| ScaleUpRules |
object |
スケールアウトルール。 |
|
| Step |
integer |
スケールアウトの拡張のステップサイズ。一度に追加できるインスタンスの最大数。 |
100 |
| StabilizationWindowSeconds |
integer |
スケールアウトのクールダウン期間。値は 0 から 3600 までの整数です。単位:秒。デフォルト値:0。 |
300 |
| Disabled |
boolean |
スケールインが無効になっているかどうかを示します。有効な値:
説明
この機能を有効にすると、アプリケーションはスケールインされなくなります。これにより、ピーク時間中のスケールインによるビジネスリスクを防ぐことができます。デフォルトでは、この機能は無効になっています。 |
false |
| ScaleDownRules |
object |
スケールインルール。 |
|
| Step |
integer |
スケールインの拡張のステップサイズ。一度に削除できるインスタンスの最大数。 |
100 |
| StabilizationWindowSeconds |
integer |
スケールインのクールダウン期間。値は 0 から 3600 までの整数です。単位:秒。デフォルト値:0。 |
300 |
| Disabled |
boolean |
スケールインが無効になっているかどうかを示します。有効な値:
説明
この機能を有効にすると、アプリケーションはスケールインされなくなります。これにより、ピーク時間中のスケールインによるビジネスリスクを防ぐことができます。デフォルトでは、この機能は無効になっています。 |
false |
| ScaleRuleName |
string |
オートスケーリングポリシーの名前。 |
test |
| MinReadyInstances |
integer |
準備完了状態の最小インスタンス数。有効な値:
説明
業務継続性を確保するために、各ローリングデプロイで準備完了状態の最小インスタンス数を 1 以上に設定してください。 |
1 |
| MinReadyInstanceRatio |
integer |
準備完了状態の最小インスタンス数のパーセンテージ。有効な値:
説明
MinReadyInstances と MinReadyInstanceRatio の両方を指定し、MinReadyInstanceRatio の値が -1 でない場合、MinReadyInstanceRatio の値が優先されます。たとえば、MinReadyInstances が 5 に設定され、MinReadyInstanceRatio が 50 に設定されている場合、準備完了状態の最小インスタンス数の計算には値 50 が使用されます。 |
-1 |
| Message |
string |
追加情報。有効な値:
|
success |
| ErrorCode |
string |
エラーコード。有効な値:
|
|
| Code |
string |
HTTP ステータスコードまたは POP エラーコード。有効な値:
|
200 |
| Success |
boolean |
アプリケーションインスタンスの再起動が成功したかどうかを示します。
|
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
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。