全部產品
Search
文件中心

Data Management:ModifyBackupSourceEndpoint - 修改Database Backup源

更新時間:Apr 25, 2026

該介面用於修改Database Backup源。

調試

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

調試

授權資訊

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

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dbs:ModifyBackupSourceEndpoint

update

*BackupPlan

acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

無 無

請求參數

名稱

類型

必填

描述

樣本值

BackupPlanId

string

是

備份計劃 ID,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

dbs1h****usfa

SourceEndpointInstanceType

string

是

資料庫所在位置,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。取值如下:

  • RDS

  • ECS

  • Express:通過專線/VPN 閘道/智能網關接入的資料庫

  • Agent:通過備份網關接入的資料庫

  • DDS:雲 MongoDB

  • Other:通過 IP:Port 直連的資料庫

RDS

SourceEndpointRegion

string

否

資料庫地區,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

說明

SourceEndpointInstanceType 為 RDS、ECS、DDS、Express、Agent 時,該參數必傳。

cn-hangzhou

SourceEndpointInstanceID

string

否

資料庫執行個體 ID,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

說明

SourceEndpointInstanceType 為 RDS、ECS、DDS、Express 時,該參數必傳。

rm-bp1p8c29479jv****

SourceEndpointIP

string

否

資料庫連接地址,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

說明

SourceEndpointInstanceType 為 Express、Agent、Other 時該參數必傳。

100.*.*.10:3306

SourceEndpointPort

integer

否

資料庫連接埠,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

說明

SourceEndpointInstanceType 為 Express、Agent、Other、ECS,該參數必傳。

3306

SourceEndpointDatabaseName

string

否

資料庫名稱。

  • 資料庫類型為 PostgreSQL、MongoDB 時,該參數必傳。

  • 資料庫所在位置為 Agent 且資料庫類型為 MSSQL 時,該參數必傳。

test

SourceEndpointUserName

string

否

資料庫帳號,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

資料庫類型為 Redis,或者資料庫所在位置為 Agent 且資料庫類型為 MSSQL 時該參數非必須,其他情境均必傳。

test

SourceEndpointPassword

string

否

密碼。

資料庫類型為 Redis,或者資料庫所在位置為 Agent 且資料庫類型為 MSSQL 時該參數非必須,其他情境均必傳。

test

BackupGatewayId

integer

否

備份網關 ID,可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

說明

SourceEndpointInstanceType 為 Agent 時,該參數必傳。

21321323213

BackupObjects

string

否

備份對象,當資料庫所在位置為 Agent 時,該參數非必須,其他情境均必傳。可通過調用 DescribeBackupPlanList 介面擷取該參數的值。

[{ "DBName":"待備份庫名", "SchemaName":"待備份 Schema 名", "TableIncludes":[{ "TableName":"待備份表表名" }], "TableExcludes":[{"TableName":"待備份庫名不需要備份表的表名" }] } ]

SourceEndpointOracleSID

string

否

Oracle SID 名稱,資料庫類型為 Oracle 時,該參數必傳。

test

CrossAliyunId

string

否

跨阿里雲帳號備份的 UID。

2xxx7778xxxxxxxxxx

CrossRoleName

string

否

跨阿里雲帳號備份的 RAM 角色名稱。

test123

ClientToken

string

否

任一字元串,用於保證請求的等冪性,防止重複提交請求。

ETnLKlblzczshOTUbOCzxxxxxxx

EnableSourceEndpointSsl

string

否

是否通過 SSL 安全連線備份來源資料庫執行個體。

true

SslCaPem

string

否

配置 SSL 安全連線的 PEM 認證

-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----

SourceEndpointOracleHome

string

否

Oracle Home

/home/test

返回參數

名稱

類型

描述

樣本值

object

HttpStatusCode

integer

HTTP 狀態代碼。

200

RequestId

string

請求 ID。

D6E068C3-25BC-455A-85FE-45F0B22E****

ErrCode

string

錯誤碼。

Param.NotFound

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功

  • false:請求失敗

true

ErrMessage

string

錯誤資訊。

The specified parameter %s value is not valid.

BackupPlanId

string

備份計劃 ID。

dbs1h****usfa

NeedPrecheck

boolean

本次修改是否會觸發預檢查,如果為 true 則需要再調用 StartBackupPlan 介面啟動備份計劃。

false

樣本

正常返回樣本

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbs1h****usfa",
  "NeedPrecheck": false
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

403 Request.Forbidden Have no Permissions 當前操作未被授權,請聯絡主帳號在RAM控制台進行授權後再執行操作

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

變更歷史

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