ModifyNodePoolAttribute - App Streaming - Alibaba Cloud ドキュメントセンター

デリバリーグループのスケーリングモードを変更します。スケーリングモードには、固定数量 (弾力的スケーリングなし)、スケジュールに基づくスケーリング、自動スケーリングがあります。

操作説明

WUYING Cloud Application リソースのスケーリングパターンは、[設定] で構成できます。

固定数量：弾力的なスケーリングは使用しません。
自動スケーリング：接続セッション数と、セッションが接続されていないアイドル期間に基づいて、リソースを自動的にスケーリングします。
スケジュールに基づくスケーリング：指定された日付の指定された期間にリソースをスケーリングします。

この API を使用する前に、WUYING Cloud Application の課金方法と料金を十分に理解していることを確認してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

appstreaming:ModifyNodePoolAttribute

update

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProductType	string	任意	製品タイプ。列挙値: CloudApp : WUYING クラウドアプリケーション。	CloudApp
PoolId	string	任意	ノードプール ID。	rg-ew7va2g1wl3vm****
NodeCapacity	integer	任意	同時セッション数。1 つのリソースに同時に接続できるセッション数です。同時に接続されるセッション数が多すぎると、アプリケーションの使用感が低下する場合があります。有効な値はリソース仕様によって異なります。各リソース仕様の有効な値は次のとおりです： appstreaming.general.4c8g：1～2。 appstreaming.general.8c16g：1～4。 appstreaming.vgpu.8c16g.4g：1～4。 appstreaming.vgpu.8c31g.16g：1～4。 appstreaming.vgpu.14c93g.12g：1～6。	2
NodePoolStrategy	object	任意	デリバリーグループの自動スケーリングポリシー。
StrategyType	string	任意	スケーリングモード。説明 `NODE_FIXED` (固定数)：サブスクリプションおよび従量課金リソースに適用されます。 `NODE_SCALING_BY_USAGE` (自動スケーリング)：サブスクリプションおよび従量課金リソースに適用されます。 `NODE_SCALING_BY_SCHEDULE` (スケジュールに基づくスケーリング)：従量課金リソースにのみ適用されます。列挙値: NODE_FIXED : 固定数 (弾性スケーリングなし)。 NODE_SCALING_BY_SCHEDULE : スケジュールに基づくスケーリング。 NODE_SCALING_BY_USAGE : 自動スケーリング。	NODE_FIXED
NodeAmount	integer	任意	購入済みリソース数。有効な値：1～100。説明リソースがサブスクリプションリソースの場合、このパラメータは変更できません。リソースが従量課金リソースの場合、スケーリングモード (`StrategyType`) が固定数 (`NODE_FIXED`) または自動スケーリング (`NODE_SCALING_BY_USAGE`) に設定されているときに、このパラメータを変更できます。	1
MaxScalingAmount	integer	任意	スケールアウト中に作成できるリソースの最大数。 `StrategyType` が `NODE_SCALING_BY_USAGE` に設定されている場合、このパラメータは必須です。	10
MaxIdleAppInstanceAmount	integer	任意	アイドルセッションの最大数。この値を指定した場合、セッション使用率が `ScalingUsageThreshold` を超え、かつ現在のデリバリーグループのアイドルセッション数が `MaxIdleAppInstanceAmount` 未満のときにのみ、自動スケールアウトがトリガーされます。それ以外の場合、デリバリーグループのアイドルセッションは十分であると見なされ、自動スケールアウトは実行されません。このパラメータを使用すると、弾性スケールアウトの動作を柔軟に制御し、コストを削減できます。	3
ScalingStep	integer	任意	スケールアウト 1 回あたりに作成されるリソース数。有効な値：1～10。 `StrategyType` が `NODE_SCALING_BY_USAGE` に設定されている場合、このパラメータは必須です。	2
ScalingUsageThreshold	string	任意	セッション使用率 (%) の上限しきい値。セッション使用率がこのしきい値を超えると、自動スケールアウトがトリガーされます。セッション使用率は次の式で算出されます：`セッション使用率 = 現在のセッション数 ÷ (総リソース数 × リソースあたりの同時セッション数) × 100%`。 `StrategyType` が `NODE_SCALING_BY_USAGE` に設定されている場合、このパラメータは必須です。有効な値：0～100。デフォルト値：85。	85
ScalingDownAfterIdleMinutes	integer	任意	セッション接続がないリソースを保持する最大時間 (分)。リソースにセッションが接続されていない場合、ここで指定した時間に基づいてカウントダウンが開始されます。カウントダウンが終了すると、リソースはスケールインされます。有効な値：5～120。デフォルト値：5。次の例外があります：スケールインによって再度自動スケールアウトがトリガーされる場合、スケールインとスケールアウトの繰り返しを防ぐため、スケールインは実行されません。この期間中にセッションの増加によって自動スケールアウトがトリガーされた場合、リソースは当初の予定どおりにスケールインされず、カウントダウンが再開されます。	5
StrategyEnableDate	string	任意	ポリシーが有効になる日付。形式：yyyy-MM-dd。日付は現在の日付以降である必要があります。 `StrategyType` (スケーリングモード) が `NODE_SCALING_BY_SCHEDULE` (スケジュールに基づくスケーリング) に設定されている場合、このパラメータは必須です。	2023-01-05
StrategyDisableDate	string	任意	ポリシーが無効になる日付。形式：yyyy-MM-dd。無効になる日付と有効になる日付の間隔は、7 日～1 年 (両端含む) である必要があります。 `StrategyType` (スケーリングモード) が `NODE_SCALING_BY_SCHEDULE` (スケジュールに基づくスケーリング) に設定されている場合、このパラメータは必須です。	2023-01-19
WarmUp	boolean	任意	リソースプリフェッチポリシーを有効にするかどうかを指定します。 `StrategyType` (スケーリングモード) が `NODE_SCALING_BY_SCHEDULE` (スケジュールに基づくスケーリング) に設定されている場合、このパラメータは必須です。	false
RecurrenceSchedules	array<object>	任意	ポリシー実行サイクルのリスト。 `StrategyType` (スケーリングモード) が `NODE_SCALING_BY_SCHEDULE` (スケジュールに基づくスケーリング) に設定されている場合、このパラメータは必須です。
	array<object>	任意	ポリシー実行サイクル。
RecurrenceType	string	任意	ポリシー実行サイクルのタイプ。 `RecurrenceType` と `RecurrenceValues` の両方を指定する必要があります。列挙値: weekly : 週ごと (スケジュールされたタスクは、毎週指定した曜日に実行されます)。	weekly
RecurrenceValues	array	任意	ポリシー実行サイクルの値のリスト。
	integer	任意	ポリシー実行サイクルの値。列挙値: 1 : 月曜日。 2 : 火曜日。 3 : 水曜日。 4 : 木曜日。 5 : 金曜日。 6 : 土曜日。 7 : 日曜日。	1
TimerPeriods	array<object>	任意	ポリシー実行サイクルの時間帯のリスト。時間帯設定の要件：時間帯は最大 3 つまで追加できます。時間帯は重複できません。時間帯の間隔は 5 分以上である必要があります。各時間帯は 15 分以上である必要があります。すべての時間帯を合計しても日をまたぐことはできません。
	object	任意	ポリシー実行サイクルの時間帯。
StartTime	string	任意	開始時刻。形式：HH:mm。	12:00
EndTime	string	任意	終了時刻。形式：HH:mm。	15:00
Amount	integer	任意	リソース数。	2
BizRegionId	string	任意	デリバリーグループのリージョン ID。サポートされているリージョンの詳細については、「制限」をご参照ください。列挙値: cn-shanghai : China (Shanghai)。 cn-hangzhou : China (Hangzhou)。	cn-hangzhou

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター
RequestId	string	リクエスト ID	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
Code	string	リクエストが失敗した場合に返されるエラーコード。	InvalidParameter.PoolId
Message	string	リクエストが失敗した場合に返されるエラーメッセージ。	The parameter PoolId is invalid.

例

成功レスポンス

JSONJSON

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "Code": "InvalidParameter.PoolId",
  "Message": "The parameter PoolId is invalid."
}

エラーコード

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

変更履歴

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