CreateAutoSnapshotPolicy - Elastic Compute Service

在指定地域下建立一條自動快照原則。可以指定自動快照的重複週期、保留時間以及跨地域備份等原則，為系統磁碟或資料磁碟建立快照備份資料。

介面說明

呼叫該介面之前，請認真閱讀建立自動快照原則。

呼叫該介面時，您需要注意：

一個阿里雲帳號在一個地域最多能建立 100 條自動快照原則。當某塊雲端硬碟的自動快照數量達到額度上限，系統在建立新的快照任務時，會刪除由自動快照原則所產生的時間最早的自動快照點。
當 ECS 執行個體存在停止或者重新啟動任務時，系統不會執行自動快照原則。
已啟用快照跨地域複製且在未設定加密參數場景下，加密快照預設使用目的端服務金鑰進行加密複製。跨地域複製快照的注意事項，請參見複製快照。

建立自動快照原則後，需要呼叫 ApplyAutoSnapshotPolicy 將原則應用到目標雲端硬碟。如果您需要調整自動快照原則的內容，請呼叫 ModifyAutoSnapshotPolicyEx 。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ecs:CreateAutoSnapshotPolicy

create

*AutoSnapshotPolicy

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

無

請求參數

名稱	類型	必填	描述	樣本值
regionId	string	是	自動快照原則所屬的地域。您可以呼叫 DescribeRegions 檢視最新的阿里雲地域清單。	cn-hangzhou
autoSnapshotPolicyName	string	否	自動快照原則的名稱。長度為 2~128 個英文或中文字元。必須以大小寫字母或中文開頭，不能以 http://或 https://開頭。可以包含數字、半形冒號（:）、底線（_）或者連字號（-）。預設值：空	TestName
timePoints	string	是	自動快照的建立時間點。使用 UTC +8 時間，單位為小時。取值範圍：0~23，代表 00:00 至 23:00 共 24 個時間點，例如 1 表示 01:00。格式說明：傳入的參數需要保持 JSON 陣列格式。例如，["1"]表示 01:00 建立自動快照。當一天內需要建立多次自動快照時，可以傳入多個時間點，時間點之間用半形逗號（,）隔開，最多傳入 24 個時間點。例如，["1","3","5"]表示 01:00、03:00、05:00 時建立自動快照。說明如果雲端硬碟資料較多，單次建立自動快照的時長超過兩個時間點之間的間隔，則自動跳過下一時間點。例如：您分別設定了 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"]表示每週一重複建立自動快照。當一星期內需要建立多次自動快照時，可以傳入多個時間點，時間點之間用半形逗號（,）隔開，最多傳入 7 個時間點。例如，["1","3","5"]表示每週一、週三、週五重複建立自動快照。	["1","2"]
retentionDays	integer	是	自動快照的保留時間，單位為天。取值範圍： -1：永久儲存 1~65535：指定儲存天數預設值：-1。	30
EnableCrossRegionCopy	boolean	否	是否允許自動跨地域複製。 true：允許。 false：不允許。	false
TargetCopyRegions	string	否	跨地域複製快照的目標地域。目前支援設定一個目標地域。	["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

樣本

正常返回樣本

JSON格式

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

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	您需要開通 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.	找不到對應的資源群組。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。