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

指定されたリージョンに自動スナップショットポリシーを作成します。システムクラウドディスクまたはデータクラウドディスクのデータをバックアップするために、自動スナップショットの繰り返しサイクル、保持期間、およびクロスリージョンバックアップ設定を指定できます。

操作説明

この操作を呼び出す前に、「自動スナップショットポリシーの作成」をお読みください。

以下の項目にご注意ください。

Alibaba Cloud アカウントあたり、1 つのリージョンで最大値 100 個の自動スナップショットポリシーを作成できます。ディスクの自動スナップショット数がクォータ制限に達した場合、新しいスナップショットタスクが開始されると、システムは自動スナップショットポリシーによって作成された最も古い自動スナップショットを削除します。
ECS インスタンスに保留中の停止または再起動タスクがある場合、システムは自動スナップショットポリシーを実行しません。
クロスリージョンスナップショットレプリケーションが有効になっており、暗号化パラメーターが設定されていない場合、デフォルトでは送信先リージョンのサービスキーを使用して、暗号化されたスナップショットが送信先リージョンに複製されます。クロスリージョンスナップショットレプリケーションの詳細については、「スナップショットのコピー」をご参照ください。

自動スナップショットポリシーを作成した後、 ApplyAutoSnapshotPolicy を呼び出してポリシーをディスクに適用します。自動スナップショットポリシーを変更するには、 ModifyAutoSnapshotPolicyEx を呼び出します。

今すぐお試しください

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

create

*AutoSnapshotPolicy

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
regionId	string	必須	自動スナップショットポリシーが属するリージョンの ID。 DescribeRegions を呼び出して、最新のリージョンリストを取得できます。	cn-hangzhou
autoSnapshotPolicyName	string	任意	自動スナップショットポリシーの名前。名前の長さは 2～128 文字である必要があります。名前は英字で始める必要があり、http:// または https:// で始めることはできません。名前には数字、コロン (:)、アンダースコア (_)、ハイフン (-) を含めることができます。デフォルト値: null。	TestName
timePoints	string	必須	自動スナップショットが作成される時刻。時間は協定世界時 (UTC)+8 で表示されます。単位: 時間。有効な値: 0～23。これは 00:00 から 23:00 までの 24 時間の各ポイントを必須として表します。たとえば、1 は 01:00 を示します。初期化の説明: パラメーター値は JSON 配列である必要があります。たとえば、["1"] は 01:00 に自動スナップショットが作成されることを示します。 1 日に複数の自動スナップショットを作成するには、カンマ (,) で区切られた複数の時刻をセットします。最大値 24 個のポイントを指定できます。たとえば、["1","3","5"] は 01:00、03:00、05:00 に自動スナップショットが作成されることを示します。説明ディスクに large な量のデータが含まれており、自動スナップショットの作成に必要な時間が連続する 2 つの時刻の間隔を超える場合、次の時刻はスキップされます。たとえば、自動スナップショット作成の時刻として 09:00、10:00、11:00、12:00 を設定したとします。スナップショットの作成が 09:00 に開始され、10:20 に完了した場合、80 分かかります。システムは 10:00 の時刻をスキップし、次の自動スナップショットを 11:00 に作成します。	["0", "1", … "23"]
repeatWeekdays	string	必須	自動スナップショットが作成される曜日。単位: 日。サイクルは週次です。有効な値: 1～7。たとえば、1 は月曜日を意味します。形式の説明: パラメーター値は JSON 配列である必要があります。たとえば、["1"] は毎週月曜日に自動スナップショットが作成されることを示します。 1 週間に複数の自動スナップショットを作成するには、カンマ (,) で区切られた複数の曜日を指定します。最大値 7 日間を指定できます。たとえば、["1","3","5"] は毎週月曜日、水曜日、金曜日に自動スナップショットが作成されることを示します。	["1","2"]
retentionDays	integer	必須	自動スナップショットの保持期間。単位: 日。有効な値: -1: 自動スナップショットは無期限に保持されます。 1～65535: 自動スナップショットは指定された日数だけ保持されます。デフォルト値: -1。	30
EnableCrossRegionCopy	boolean	任意	自動クロスリージョンレプリケーションを有効にするかどうかを指定します。 true: 自動クロスリージョンレプリケーションを有効にします。 false: 自動クロスリージョンレプリケーションを無効にします。	false
TargetCopyRegions	string	任意	スナップショットの複製先の送信先リージョンの ID。送信先リージョンは 1 つのみ指定できます。	["cn-hangzhou"]
StorageLocationArn	string	任意	説明このパラメーターは公開されていません。	null
CopiedSnapshotsRetentionDays	integer	任意	クロスリージョンスナップショットレプリカの保持期間。単位: 日。有効な値: -1: スナップショットレプリカは無期限に保持されます。 1～65535: スナップショットレプリカは指定された日数だけ保持されます。デフォルト値: -1。	30
Tag	array<object>	任意	自動スナップショットポリシーのタグ。
	object	任意
Key	string	任意	自動スナップショットポリシーのタグキー。N の有効な値: 1～20。タグキーを空文字列にすることはできません。タグキーの長さは最大 128 文字で、aliyun または acs: で始めることはできません。タグキーに http:// または https:// を含めることはできません。	TestKey
Value	string	任意	自動スナップショットポリシーのタグ値。N の有効な値: 1～20。タグ値は空文字列にすることができます。タグ値の長さは最大 128 文字で、acs: で始めることはできません。タグ値に http:// または https:// を含めることはできません。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2kkmhmhs****
CopyEncryptionConfiguration	object	任意	スナップショットの地理的冗長性に関するバックアップの暗号化パラメーターオブジェクト。
Encrypted	boolean	任意	クロスリージョンスナップショットバックアップの暗号化を有効にするかどうかを指定します。有効な値: true: 暗号化を有効にします。 false: 暗号化を無効にします。デフォルト値: false。	false
KMSKeyId	string	任意	暗号化されたクロスリージョンスナップショットバックアップに使用される KMS キーの ID。	0e478b7a-4262-4802-b8cb-00d3fb40826X
Arn	array<object>	任意	説明このパラメーターは公開されていません。
	object	任意
RoleType	string	任意	説明このパラメーターは公開されていません。	hide
Rolearn	string	任意	説明このパラメーターは公開されていません。	hide
AssumeRoleFor	integer	任意	説明このパラメーターは公開されていません。	1000000000

レスポンスフィールド

フィールド	型	説明	例
	object
AutoSnapshotPolicyId	string	自動スナップショットポリシーの ID。	sp-bp12m37ccmxvbmi5****
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

例

成功レスポンス

JSONJSON

{
  "AutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	DiskCategory.OperationNotSupported	The type of the specified disk does not support creating a snapshot.	ディスクタイプの制限により、指定されたディスクはこの操作をサポートしていません。
400	InvalidSnapshotPolicyName.Malformed	The specified autoSnapshotPolicyName is malformed.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	タグに重複キーが存在します。キーを一意に保ってください。
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	指定されたタグキーが無効です。タグキーは空または null にできません。最大 128 文字で、「aliyun」または「acs:」で始めることはできず、「http://」または「https://」を含めることはできません。
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	指定されたタグ値が無効です。タグ値は最大 128 文字で、「http://」または「https://」を含めることはできません。
400	InvalidParameter.EncryptedIllegal	The specified parameter Encrypted must be true when kmsKeyId is not empty.	指定されたパラメーターが無効です。暗号化設定が有効かどうかを確認してください。%s は変数です。実際のエラーメッセージは API 呼び出しに基づいて動的に返されます。
400	InvalidParameter.KmsNotEnabled	Failed to perform this operation because KMS is not activated.	Key Management Service (KMS) をアクティブ化する必要があります。
400	InvalidParameter.Encrypted.KmsNotEnable	Failed to perform this operation because KMS is not activated.	KMS 鍵ホスティングサービスをホストで有効化する必要があります。
400	InvalidParam.EncryptedMismatch	Creating encrypted disks with shared encrypted image requires replacing encryption keys.	共有された暗号化イメージからディスクを作成する場合、別の暗号鍵を使用する必要があります。
403	ParameterInvalid	The specified RegionId parameter is invalid.	スナップショットルールが存在しません。
403	AutoSnapshotPolicy.QuotaExceed	The maximum number of automatic snapshot policy has been reached.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	InvalidAccountStatus.SnapshotServiceUnavailable	Snapshot service has not been opened yet.	スナップショットサービスが有効化されていません。この操作は実行できません。
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	InvalidOperation.KMSKeyIdNotFound	The specified KMSKeyId not found, %s.	関連付けられた KMS 暗号鍵が見つかりません。KMS 暗号鍵が有効であることを確認してください。
403	Abs.InvalidAction.RegionNotSupport	This region does not support this action.	このリージョンはこの操作をサポートしていません。
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK (Customer Master Key) must be in an active state.	カスタマーマスターキー (CMK) はアクティブな状態である必要があります。
403	InvalidParameter.KMSKeyId.CMKUnauthorized	The CMK(Customer Master Key) lacks authorization to add tags to the ECS service.	ECS には CMK を暗号化するまたは復号する権限がありません。
403	InvalidStorageLocationArn.Malformed	The specified parameter StorageLocationArn is malformed.
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	指定されたリソースグループが見つかりませんでした。

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

変更履歴

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