CreateBackup - 為RDS執行個體建立備份組 - ApsaraDB RDS

該介面用於為RDS執行個體建立一個備份組。

介面說明

適用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

功能說明

本介面調用的是 RDS 內建的備份功能介面，您也可以使用 DBS。更多資訊，請參見DBS API 概覽。

注意事項

調用該介面時，執行個體必須滿足以下條件，否則將操作失敗：

執行個體狀態為運行中。
沒有正在執行中的備份任務。
單個執行個體一天內可建立的備份組數量不超過 20 個。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

rds:CreateBackup

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。可調用 DescribeDBInstances 擷取。	rm-uf6wjk5****
DBName	string	否	資料庫列表，多個資料庫之間用英文逗號（,）隔開。說明滿足以下條件時，該參數生效：已傳入 BackupStrategy 參數（取值為 db）。	rds_mysql
BackupStrategy	string	否	備份策略，取值： db：單庫備份 instance：執行個體備份說明滿足以下條件時，該參數生效： MySQL：已傳入 BackupMethod 參數（取值 Logical）。 SQL Server：已傳入 BackupType 參數（取值為 FullBackup）	db
BackupMethod	string	否	備份類型，取值： Logical：邏輯備份（僅 MySQL 本地碟支援） Physical：物理備份（MySQL 本地碟、SQL Server、PostgreSQL 支援） Snapshot：快照備份（MySQL 雲端硬碟、SQL Server、PostgreSQL、MariaDB 均支援）預設值：Physical。說明使用邏輯備份時，資料庫內需要有儲存資料（資料不為空白）。 MariaDB 執行個體僅支援快照備份，但參數取值請填寫 Physical。	Physical
BackupType	string	否	SQL Server 執行個體備份方式，取值： Auto（預設值）：自動選擇全量備份或增量備份 FullBackup：全量備份說明該值僅在 BackupMethod 參數為 Physical 時生效。	Auto
BackupRetentionPeriod	integer	否	SQL Serevr：當參數 BackupStrategy 為 db、BackupMethod 為 Physical 且 BackupType 為 FullBackup 時，支援指定備份組的保留時間，取值 7~730 天、-1（長期保留）。 MySQL：支援指定備份組的保留時間，取值 7~730 天、-1（長期保留）	7

如何填寫選擇性參數

該 API 存在四個選擇性參數：BackupMethod、BackupStrategy、BackupType 和 DBName，對於不同引擎和使用情境，需要搭配不同的選擇性參數。

MySQL

物理備份、快照備份：僅需填寫 BackupMethod，預設備份所有庫，不支援單庫備份。
邏輯備份：
- 單庫：需填寫 BackupMethod、BackupStrategy 和 DBName。
- 整執行個體：需填寫 BackupMethod 和 BackupStrategy。

SQL Server

快照備份：僅需填寫 BackupMethod，預設備份所有庫，不支援單庫備份。
物理備份：
- 單庫全量：四個選擇性參數均需填寫
- 整執行個體全量：需填寫 BackupMethod、BackupType 和 BackupStrategy。
- 系統自動判斷增量或全量備份：需填寫 BackupMethod 和 BackupType。
邏輯備份：不支援。

PostgreSQL

物理備份、快照備份：僅需填寫 BackupMethod，預設備份所有庫，不支援單庫備份。
邏輯備份：不支援。

MariaDB

快照備份：僅需填寫 BackupMethod，預設備份所有庫，不支援單庫備份。
物理備份、邏輯備份：不支援。

返回參數

名稱	類型	描述	樣本值
	object	返回參數詳情。
BackupJobId	string	備份任務 ID。	507****
RequestId	string	請求 ID。	2C125605-266F-41CA-8AC5-3A643D4F42C5

樣本

正常返回樣本

JSON格式

{
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

異常返回樣本