修改MongoDB實例的備份策略。
接口說明
異地備份只適用于云盤副本集、云盤分片實例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
dds:ModifyBackupPolicy | update | *Instance acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實例 ID。 | dds-bp16cb162771**** |
PreferredBackupTime | string | 否 | 執行備份的時間,格式為HH:mmZ-HH:mmZ(UTC 時間)。 說明
時間范圍限制為 1 小時。
| 03:00Z-04:00Z |
PreferredBackupPeriod | string | 否 | 備份周期,取值說明:
注意 為了數據安全,請一周至少備份兩次 MongoDB 說明
傳入多個值,請用英文逗號(,)隔開。
| Monday,Wednesday,Friday,Sunday |
BackupRetentionPeriod | long | 否 | 全量備份保留天數。 說明
| 30 |
EnableBackupLog | long | 否 | 是否打開日志備份,取值說明:
| 0 |
LogBackupRetentionPeriod | long | 否 | 日志備份保留天數,默認為 7 天。 取值范圍:7~730。 | 7 |
SnapshotBackupType | string | 否 | 快照備份類型,取值說明:
| Standard |
BackupInterval | string | 否 | 高頻備份頻率,取值說明:
說明
| -1 |
HighFrequencyBackupRetention | long | 否 | 高頻備份保留天數,使用該參數前需要先確認已經傳入 BackupInterval 字段。默認保留時長一天。 | 1 |
BackupRetentionPolicyOnClusterDeletion | integer | 否 | 2 | |
CrossBackupType | string | 否 | 異地備份操作策略:
說明
異地備份必填
| update |
SrcRegion | string | 否 | 實例所在地域。 說明
| cn-beijing |
DestRegion | string | 否 | 備份所在地域。 說明
異地備份必填
| cn-hangzhou |
CrossRetentionType | string | 否 | 異地備份保留類型。
說明
異地備份必填
| delay |
CrossRetentionValue | integer | 否 | 異地備份保留時長,可設置 3-1825 天。 說明
| 7 |
CrossBackupPeriod | string | 否 | 異地備份的保留時間。
說明
異地備份必填
| Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday |
EnableCrossLogBackup | integer | 否 | 是否開啟跨地域日志備份 。 說明
異地備份必填
| 1 |
CrossLogRetentionType | string | 否 | 異地日志備份保留類型。
說明
異地備份必填
| delay |
CrossLogRetentionValue | integer | 否 | 異地日志備份保留時長,可設置 3-1825 天,需要小于等于 CrossRetentionValue 的值。 說明
異地備份必填
| 3 |
InstanceType | string | 否 | 實例類型,取值:
說明
| replicate |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | InvalidPreferredBackupPeriod.Malformed | Specified parameter PreferredBackupPeriod is not valid. |
400 | InvalidPreferredBackupTime.Malformed | Specified parameter PreferredBackupTime is not valid. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-02-22 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |