CreatePlanMaintenanceWindow - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

O&M ウィンドウを作成します。O&M ウィンドウの TargetResource パラメーターが ECS インスタンスに関連付けられるようにセットされており、スケジュールされた O&M による軽減が必要な基盤ハードウェアリスクが検出された場合、スケジュールされた O&M の実行時刻は TimePeriod パラメーターで指定された時間有効値によって決定されます。O&M イベントの実行時刻に達すると、プラットフォームはイベントタイプに基づいて対応する O&M 操作を自動的に実行します。DescribeRegions を呼び出して最新のリージョンリストをクエリできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:CreatePlanMaintenanceWindow

create

*All Resource

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PlanWindowName	string	必須	O&M ウィンドウの名前。カスタム名を指定できます。名前の長さは最大 200 文字です。	WIndowName
Enable	boolean	必須	O&M ウィンドウを有効にするかどうかを指定します。 true: 有効。 false: 無効。	true
SupportMaintenanceAction	string	必須	O&M ウィンドウでサポートされる O&M 操作。列挙値: Redeploy : Redeploy。 Reboot : Reboot。	Reboot
RegionId	string	必須	リージョン ID。DescribeRegions を呼び出して最新のリージョンリストをクエリできます。	cn-hangzhou
TimePeriod	object	必須	O&M ウィンドウの繰り返しサイクル。
PeriodUnit	string	必須	サイクルのタイプ。有効な値: Daily および Weekly。列挙値: Daily : Daily。 Weekly : Weekly。	Weekly
RangeList	array<object>	必須	O&M ウィンドウの繰り返しサイクルの時間有効値 (協定世界時 (UTC))。
	object	任意	時間有効値オブジェクト。
StartTime	string	任意	O&M ウィンドウの開始時刻。 PeriodUnit が Weekly にセットされている場合、初期化は Monday,22:00 です。Monday は Tuesday、Wednesday、Thursday、Friday、Saturday、または Sunday に置き換えできます。 PeriodUnit が Daily にセットされている場合、初期化は 22:00 です。コンマ (,) がデリミタとして使用されます。最初の部分は時間を表し、有効値は 00 から 23 です。2 番目の部分は分を表し、現在は 00 のみサポートされています。	Monday,22:00
EndTime	string	任意	O&M ウィンドウの終了時刻。 PeriodUnit が Weekly にセットされている場合、初期化は Monday,22:00 です。Monday は Tuesday、Wednesday、Thursday、Friday、Saturday、または Sunday に置き換えできます。 PeriodUnit が Daily にセットされている場合、初期化は 22:00 です。コンマ (,) がデリミタとして使用されます。最初の部分は時間を表し、有効値は 00 から 23 です。2 番目の部分は分を表し、現在は 00 のみサポートされています。	Tuesday,03:00
TargetResource	object	必須	O&M ウィンドウが適用されるリソース。
Scope	string	必須	O&M ウィンドウのリソースタイプ。列挙値: All : All。 Tag : Tag。 ResourceGroup : ResourceGroup。	Tag
ResourceGroupId	string	任意	リソースグループの ID。Scope が ResourceGroup に設定されている場合、このパラメーターは必須です。	rg-aekzhm7pmnvcbty
Tags	array<object>	任意	O&M ウィンドウが適用されるタグ。Scope が Tag に設定されている場合、このパラメーターは必須です。
	object	任意	タグ値
Key	string	任意	O&M ウィンドウが適用されるタグのキー。	vms_qualification_孙总身份证_e5590864-1fef-4db2-b2a7-bd2d657fed43.png
Value	string	任意	O&M ウィンドウが適用されるタグの値。	21.137.18.60
MinMaintenanceInterval	integer	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID	7D5B1188-3F08-56D1-A6B2-91B267452633
PlanWindowId	string	作成された O&M ウィンドウの ID。	pw-bp1a9yavgq3dgttvowun

例

成功レスポンス

JSONJSON

{
  "RequestId": "7D5B1188-3F08-56D1-A6B2-91B267452633",
  "PlanWindowId": "pw-bp1a9yavgq3dgttvowun"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidOperation.TooManyMaintenanceWindows	Too many maintenance windows.
500	InternalError	Internal error.
403	AccessForbidden	User not authorized to operate on the specified resource.
403	MissingParameter.Period	The input parameter Period is missing.
403	MissingParameter.TargetType	The input parameter TargetType is missing.
403	InvalidParameter.TimePeriod	Invalid Parameter Time Period.
403	InvalidParameter.TargetResource	Invalid Parameter Target Resource.
403	InvalidParameter.SupportMaintenanceAction	Invalid Parameter SupportMaintenanceAction.
403	InvalidParameter.MinMaintenanceInterval	Invalid Parameter MinMaintenanceInterval.	MinMaintenanceInterval 参数设置错误

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

変更履歴

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