該接口用于配置一個(gè)DBS備份計(jì)劃。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dbs:ConfigureBackupPlan | update |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BackupPlanId | string | 是 | 備份計(jì)劃 ID,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 | dbstooi0******* |
SourceEndpointInstanceType | string | 是 | 數(shù)據(jù)庫(kù)所在位置,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。取值如下:
| RDS |
SourceEndpointRegion | string | 否 | 數(shù)據(jù)庫(kù)地域,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
SourceEndpointInstanceType 為 RDS、ECS、DDS、Express、Agent 時(shí),該參數(shù)必傳。
| cn-hangzhou |
SourceEndpointInstanceID | string | 否 | 數(shù)據(jù)庫(kù)實(shí)例 ID,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
SourceEndpoint.InstanceType 為 RDS、ECS、DDS、Express 時(shí),該參數(shù)必傳。
| rm-uf6wjk5********* |
SourceEndpointIP | string | 否 | 數(shù)據(jù)庫(kù)連接地址,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
SourceEndpointInstanceType 為 express、agent、other 時(shí),該參數(shù)必傳。
| rm-uf6wjk5*******.mysql.rds.aliyuncs.com |
SourceEndpointPort | integer | 否 | 數(shù)據(jù)庫(kù)端口,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
SourceEndpoint.InstanceType 為 express、agent、other、ECS 時(shí),該參數(shù)必傳。
| 3306 |
SourceEndpointDatabaseName | string | 否 | 數(shù)據(jù)庫(kù)名稱,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
數(shù)據(jù)庫(kù)類型為 PostgreSQL、MongoDB 時(shí),該參數(shù)必傳。
| testRDS |
SourceEndpointUserName | string | 否 | 數(shù)據(jù)庫(kù)賬號(hào)。 說(shuō)明
數(shù)據(jù)庫(kù)類型為 Redis,或者數(shù)據(jù)庫(kù)所在位置為 agent 且數(shù)據(jù)庫(kù)類型為SQL Server時(shí)該參數(shù)非必須,其他場(chǎng)景均必傳。
| testRDS |
SourceEndpointPassword | string | 否 | 密碼。 說(shuō)明
數(shù)據(jù)庫(kù)類型為 Redis,或者數(shù)據(jù)庫(kù)所在位置為 agent 且數(shù)據(jù)庫(kù)類型為SQL Server時(shí)該參數(shù)非必須,其他場(chǎng)景均必傳。
| testPassword |
BackupGatewayId | long | 否 | 備份網(wǎng)關(guān) ID,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 說(shuō)明
SourceEndpointInstanceType 為 agent 時(shí),該參數(shù)必傳。
| 23313123312 |
OSSBucketName | string | 否 | OSS Bucket 名稱。 說(shuō)明
系統(tǒng)默認(rèn)自動(dòng)生成新的名稱。
| TestOssBucket |
BackupObjects | string | 否 | 備份對(duì)象,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 | [ { "DBName":"待備份庫(kù)名", "SchemaName":"待備份 Schema 名", "TableIncludes":[{ "TableName":"待備份表表名" }], "TableExcludes":[{ "TableName":"待備份庫(kù)名不需要備份表的表名" }] } ] |
BackupPeriod | string | 否 | 全量備份周期,取值:
| Monday |
BackupStartTime | string | 否 | 全量備份開始時(shí)間,格式為HH:mmZ(UTC 時(shí)間)。可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 | 14:22 |
EnableBackupLog | boolean | 否 | 是否開啟增量日志備份,取值:
| true |
BackupLogIntervalSeconds | integer | 否 | 增量時(shí)間間隔,以秒(s)為單位。 說(shuō)明
僅支持物理備份。
| 1000 |
BackupRetentionPeriod | integer | 否 | 備份數(shù)據(jù)保留時(shí)間,取值:0 ~ 1825,默認(rèn)為 730 天。 | 730 |
DuplicationInfrequentAccessPeriod | integer | 否 | 轉(zhuǎn)為低頻訪問存儲(chǔ)時(shí)間,默認(rèn)為 180 天。 | 180 |
DuplicationArchivePeriod | integer | 否 | 轉(zhuǎn)為歸檔冷備存儲(chǔ)時(shí)間,默認(rèn)為 365 天。 | 365 |
BackupPlanName | string | 是 | 自定義備份計(jì)劃名稱,可通過調(diào)用 DescribeBackupPlanList 接口獲取該參數(shù)的值。 | dbstooi0******* |
SourceEndpointOracleSID | string | 否 | Oracle SID 名稱。 說(shuō)明
數(shù)據(jù)庫(kù)類型為 Oracle 時(shí),該參數(shù)必傳。
| test |
BackupStorageType | string | 否 | 內(nèi)置存儲(chǔ)類型:
| 無(wú) |
BackupSpeedLimit | long | 否 | 磁盤 IO 限制 , 單位為 KB/s。 說(shuō)明
僅對(duì) MySQL 物理備份生效。
| 262144 |
BackupRateLimit | long | 否 | 網(wǎng)絡(luò)帶寬限制, 單位為 KB/s ,最大允許 10GB。 說(shuō)明
僅對(duì) MySQL 物理備份生效。
| 262144 |
BackupStrategyType | string | 否 | 全量備份周期,取值:
說(shuō)明
默認(rèn)為 simple。
| simple |
CrossAliyunId | string | 否 | 跨阿里云賬號(hào)備份的 UID,可通過調(diào)用 DescribeRestoreTaskList 接口獲取該參數(shù)的值。 | 2xxx7778xxxxxxxxxx |
CrossRoleName | string | 否 | 跨阿里云賬號(hào)備份的 RAM 角色名稱,可通過調(diào)用 DescribeRestoreTaskList 接口獲取該參數(shù)的值。 | test123 |
AutoStartBackup | boolean | 否 | 是否開啟自動(dòng)備份。
| false |
ClientToken | string | 否 | 用于保證請(qǐng)求的冪等性,防止重復(fù)提交請(qǐng)求。由客戶端生成該參數(shù)值,要保證在不同請(qǐng)求間唯一,最大值不超過 64 個(gè) ASCII 字符,且該參數(shù)值中不能包含非 ASCII 字符。 | ETnLKlblzczshOTUbOCzxxxxxxx |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aekzecovzti**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
"ErrCode": "Param.NotFound",
"Success": true,
"ErrMessage": "The specified parameter %s value is not valid. ",
"BackupPlanId": "dbstooi01ex****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
403 | Request.Forbidden | Have no Permissions | 當(dāng)前操作未被授權(quán),請(qǐng)聯(lián)系主賬號(hào)在RAM控制臺(tái)進(jìn)行授權(quán)后再執(zhí)行操作 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|