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

スナップショットの作成時間、繰り返し頻度、保持期間などの自動スナップショットポリシーを変更します。

操作説明

この操作の呼び出し時は、以下の点に注意してください。

システムポリシーは変更できません。
自動スナップショットポリシーを変更すると、そのポリシーが適用されているディスクは直ちに変更済みポリシーを使用します。
クロスリージョンスナップショットレプリケーションが有効になっており、暗号化パラメーターが設定されていない場合、暗号化されたスナップショットはデフォルトで送信先リージョンのサービスキーを使用してコピーされます。

今すぐお試しください

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

update

*Snapshot。

acs:ecs:{#regionId}:{#accountId}:snapshotpolicy/{#autoSnapshotPolicyId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
regionId	string	必須	自動スナップショットポリシーのリージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
autoSnapshotPolicyId	string	必須	自動スナップショットポリシーの ID。 DescribeAutoSnapshotPolicyEx を呼び出して、利用可能な自動スナップショットポリシーをクエリできます。	sp-bp12m37ccmxvbmi5****
autoSnapshotPolicyName	string	任意	自動スナップショットポリシーの名前。このパラメーターを空のままにすると、名前は変更されません。	SPTestName
timePoints	string	任意	自動スナップショットを作成する時刻。時刻は協定世界時 (UTC)+8 であり、時間形式です。有効な値: 0～23。00:00～23:00 の 24 時刻を表します。たとえば、1 は 01:00 を表します。 1 日以内に複数の自動スナップショットを作成するには、複数の時刻を指定します。最大 24 時刻を指定できます。複数の時刻は、`"0", "1", … "23"` の形式の JSON 配列として指定します。複数の時刻はコンマ (,) で区切ります。	["0", "1"]
repeatWeekdays	string	任意	自動スナップショットを作成する曜日。有効な値: 1～7。1 は月曜日を表します。 1 週間以内に複数の自動スナップショットを作成するには、複数の曜日を指定します。最大 7 曜日を指定できます。複数の曜日は、`"1", "2", … "7"` の形式の JSON 配列として指定します。複数の曜日はコンマ (,) で区切ります。	["1", "7"]
retentionDays	integer	任意	自動スナップショットの保持期間。単位: 日。有効な値: -1: スナップショットは永続的に保持されます。 1～65536: スナップショットは指定された日数保持されます。デフォルト値: -1。	30
EnableCrossRegionCopy	boolean	任意	自動クロスリージョンスナップショットレプリケーションを許可するかどうかを指定します。有効な値: true: 許可します。 false: 許可しません。	false
TargetCopyRegions	string	任意	クロスリージョンスナップショットレプリケーションの送信先リージョン。送信先リージョンは 1 つだけ指定できます。	["cn-hangzhou"]
CopiedSnapshotsRetentionDays	integer	任意	クロスリージョンレプリケーションされたスナップショットの保持期間。単位: 日。有効な値: -1: スナップショットは永続的に保持されます。 1～65535: スナップショットは指定された日数保持されます。デフォルト値: -1。	30
CopyEncryptionConfiguration	object	任意	クロスリージョンスナップショットレプリケーションの暗号化構成。
Arn	array<object>	任意	このパラメーターは使用できません。
	object	任意
AssumeRoleFor	integer	任意	このパラメーターは使用できません。	1000000000
RoleType	string	任意	このパラメーターは使用できません。	hide
Rolearn	string	任意	このパラメーターは使用できません。	hide
Encrypted	boolean	任意	クロスリージョンスナップショットレプリケーションの暗号化を有効にするかどうかを指定します。有効な値: true: 有効にします。 false: 無効にします。デフォルト値: false。	false
KMSKeyId	string	任意	クロスリージョンの暗号化されたスナップショットのレプリケーションに使用される KMS キーのキー ID。	0e478b7a-4262-4802-b8cb-00d3fb40826X
TargetTags	array<object>	任意	ターゲットリソースタグのリスト。自動スナップショットポリシーはタグに基づいてターゲットリソースを照合します。
	object	任意	ターゲットリソースタグ。
Key	string	任意	タグキー。 N の有効な値: 1～5。タグキーは空文字列にできません。長さは最大 128 文字で、aliyun または acs: で始まること、あるいは http:// または https:// を含むことはできません。
Value	string	任意	タグ値。 N の有効な値: 1～5。タグ値の長さは最大 128 文字で、`http://` または `https://` を含めることはできません。説明空の値または空文字列を渡すと、タグ値は任意の値に一致します。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidParameter.EncryptedIllegal	The Encrypted parameter must be set to true when KMSKeyId is specified. Please adjust the parameters and try again.
400	InvalidParameter.KmsNotEnabled	The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again.
400	InvalidParameter.Encrypted.KmsNotEnable	The operation failed because KMS is not activated. Please activate KMS in the KMS console and try again.
400	InvalidParam.EncryptedMismatch	Creating a disk from a shared encrypted image requires encryption with your own KMS key. Please set the Encrypted parameter to true.
400	InvalidTargetTags.NotSupported	When the parameter AssociationType is set to AssociatedWithDisk, the TargetTags parameter is not supported.
400	InvalidTargetTagKey.Malformed	The specified TargetTag.n.Key [%s] is not valid.
400	InvalidTargetTagValue.Malformed	The specified TargetTag.n.Value [%s] is not valid.
400	Duplicate.TargetTagKey	Duplicate keys exist in the specified parameter TargetTags. Please ensure key uniqueness.
400	InvalidTargetTag.LimitExceed	The number [%s] of the specified parameter TargetTag exceeds the limit [%s].
403	ParameterInvalid	The specified RegionId parameter is invalid.	指定された自動スナップショットポリシーが存在しません。自動スナップショットポリシーが正しいことを確認してください。
403	InvalidParameter.TargetCopyRegions	The specified TargetCopyRegions is invalid.
403	InvalidParameter.CopiedSnapshotsRetentionDays	The specified CopiedSnapshotsRetentionDays is invalid.
403	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service does not have permission to access your KMS key. Please verify that the specified KMS key has authorized the ECS service.
403	Abs.InvalidAction.RegionNotSupport	This region does not support this action.	このリージョンではこの操作はサポートされていません。
403	InvalidOperation.PolicyTypeUnsupported	The current policy type does not support this operation. Only custom policies are permitted.	現在のポリシータイプでは、この操作はサポートされていません。この操作を実行できるのはカスタム権限ポリシーのみです。
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The specified KMS key must be in an enabled state. Please enable the key in the KMS console and try again.
403	InvalidParameter.KMSKeyId.CMKUnauthorized	The specified KMS key is not authorized for the ECS service. Please grant the ECS service permission to use the key in the KMS console and try again.
404	ParameterInvalid	The specified automatic snapshot policy does not exist.
404	InvalidParameter.KMSKeyId.NotFound	The specified KMSKeyId does not exist. Please verify that the key ID is correct and that the key resides in the current region.

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

変更履歴

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