在指定地域下創建一條自動快照策略?？梢灾付ㄗ詣涌煺盏闹貜椭芷?、保留時間以及跨地域備份等策略，為系統盤或數據盤創建快照備份數據。
接口說明
調用該接口之前，請認真閱讀創建自動快照策略。
調用該接口時，您需要注意：
-
一個阿里云賬戶在一個地域最多能創建 100 條自動快照策略。 當某塊云盤的自動快照數量達到額度上限，系統在創建新的快照任務時，會刪除由自動快照策略所生成的時間最早的自動快照點。
-
當 ECS 實例存在停止或者重啟任務時，系統不會執行自動快照策略。
-
已啟用快照跨地域復制且在未配置加密參數場景下，加密快照默認使用目的端服務密鑰進行加密拷貝?？绲赜驈椭瓶煺盏淖⒁馐马棧垍⒁?a class="" href="http://bestwisewords.com/zh/ecs/user-guide/copy-a-snapshot" id="">復制快照。
創建自動快照策略后，需要調用 ApplyAutoSnapshotPolicy 將策略應用到目標云盤。如果您需要調整自動快照策略的內容，請調用 ModifyAutoSnapshotPolicyEx 。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（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。格式說明：
說明
如果云盤數據較多，單次創建自動快照的時長超過兩個時間點之間的間隔，則自動跳過下一時間點。例如：您分別設置了 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 表示周一。格式說明：
| ["1","2"] |
| retentionDays | integer | 是 | 自動快照的保留時間，單位為天。取值范圍：
默認值：-1。 | 30 |
| EnableCrossRegionCopy | boolean | 否 | 是否允許自動跨地域復制。
| false |
| TargetCopyRegions | string | 否 | 跨地域復制快照的目標地域。目前支持設置一個目標地域。 | ["cn-hangzhou"] |
| StorageLocationArn | string | 否 | 說明
該參數暫未開放使用。
| null |
| CopiedSnapshotsRetentionDays | integer | 否 | 跨地域復制快照的保留時間，單位為天。取值范圍：
默認值：-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 | 否 | 是否開啟快照異地加密備份。取值范圍：
默認值：false。 | false |
| KMSKeyId | string | 否 | 快照異地加密備份使用的 KMS 密鑰 ID | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
| Arn | array<object> | 否 | 說明
該參數暫未開放使用。
| |
| object | 否 | |||
| RoleType | string | 否 | 說明
該參數暫未開放使用。
| hide |
| Rolearn | string | 否 | 說明
該參數暫未開放使用。
| hide |
| AssumeRoleFor | long | 否 | 說明
該參數暫未開放使用。
| 1000000000 |
返回參數
示例
正常返回示例
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 wrongly formed. | - |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標簽中存在重復的鍵，請保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.n.Key is not valid. | 指定的標簽鍵參數有誤。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.n.Value is not valid. | 指定的標簽值參數有誤。 |
| 400 | InvalidParameter.EncryptedIllegal | The specified parameter Encrypted must be true when kmsKeyId is not empty. | 設置參數 KMSKeyId 后，您必須開啟加密屬性。 |
| 400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盤設置了 KMSKeyId 后，CMK必須處于啟用狀態。您可以調用密鑰管理服務的 DescribeKey 接口查詢指定CMK的相關信息。 |
| 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. | 指定的地域 ID 無效，請您檢查該地域是否正確。 |
| 403 | ParameterInvalid | The specified RepeatWeekDays parameter is invalid. | 指定的日期無效，請您檢查該日期是否正確。 |
| 403 | ParameterInvalid | The specified TimePoints parameter is invalid. | 指定的時間點不合法，請您查看該時間點是否填寫正確。 |
| 403 | ParameterInvalid | The specified RetentionDays 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.CMKUnauthorized | The CMK needs to be added ECS tag. | CMK 未授權 |
| 403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服務無權訪問您的 KMS。 |
| 403 | InvalidOperation.KMSKeyIdNotFound | The specified KMSKeyId not found, %s. | 無法找到關聯的KMS加密密鑰，請確認該KMS加密密鑰有效性。 |
| 403 | Abs.InvalidAction.RegionNotSupport | This region does not support this action. | 地域不支持該操作. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-12-02 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-03-21 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2024-02-28 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |