ModifyBackupSourceEndpoint
该接口用于修改数据库备份源
服务地址:
华东1 金融云
输入参数
只看必填
BackupPlanId备份计划ID
SourceEndpointInstanceType数据库所在位置
SourceEndpointRegion数据库地域
SourceEndpointInstanceID数据库实例ID
SourceEndpointIP数据库连接地址
SourceEndpointPort数据库端口
SourceEndpointDatabaseName数据库名称
SourceEndpointUserName数据库账号
SourceEndpointPassword密码
BackupGatewayId备份网关ID
BackupObjects备份对象
SourceEndpointOracleSIDOracle SID名称
CrossAliyunId跨阿里云账号备份的UID
CrossRoleName跨阿里云账号备份的RAM角色名称
幂等性参数
ClientToken任意字符串
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
BackupPlanIdstring

备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。

示例值:dbs1h****usfa参考取值来源:
    StopBackupPlan
    UpgradeBackupPlan
    RenewBackupPlan
    StartBackupPlan
    CreateBackupPlan
    ReleaseBackupPlan
    ModifyBackupPlanName
    EnableBackupLog
    ConfigureBackupPlan
    DescribeBackupPlanList
    DisableBackupLog
SourceEndpointInstanceTypestring

数据库所在位置,可通过调用 DescribeBackupPlanList 接口获取该参数的值。取值如下:展开详情

示例值:RDS
SourceEndpointRegionstring

数据库地域,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

示例值:cn-hangzhou
SourceEndpointInstanceIDstring

数据库实例 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

示例值:rm-bp1p8c29479jv****参考取值来源:
    DescribeRestoreRangeInfo
SourceEndpointIPstring

数据库连接地址,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

示例值:100.*.*.10:3306参考取值来源:
    DescribeRestoreRangeInfo
SourceEndpointPortinteger<int32>

数据库端口,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

示例值:3306
SourceEndpointDatabaseNamestring

数据库名称。展开详情

示例值:test
SourceEndpointUserNamestring

数据库账号,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

示例值:test
SourceEndpointPasswordstring

密码。展开详情

示例值:test
BackupGatewayIdinteger<int64>

备份网关 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。展开详情

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:21321323213参考取值来源:
    DescribeBackupGatewayList
BackupObjectsstring

备份对象,当数据库所在位置为 Agent 时,该参数非必须,其他场景均必传。可通过调用 DescribeBackupPlanList 接口获取该参数的值。

示例值:[{ "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{"TableName":"待备份库名不需要备份表的表名" }] } ]参考取值来源:
    DescribeBackupPlanList
SourceEndpointOracleSIDstring

Oracle SID 名称,数据库类型为 Oracle 时,该参数必传。

示例值:test参考取值来源:
    DescribeBackupPlanList
CrossAliyunIdstring

跨阿里云账号备份的 UID,可通过调用 DescribeRestoreTaskList 接口获取该参数的值。

示例值:2xxx7778xxxxxxxxxx
CrossRoleNamestring

跨阿里云账号备份的 RAM 角色名称,可通过调用 DescribeRestoreTaskList 接口获取该参数的值。

示例值:test123
ClientTokenstring

任意字符串,用于保证请求的幂等性,防止重复提交请求。

示例值:ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 状态码。

示例值:200
RequestIdstring

请求 ID。

示例值:D6E068C3-25BC-455A-85FE-45F0B22E****
ErrCodestring

错误码。

示例值:Param.NotFound
Successboolean

请求是否成功,返回值如下:展开详情

示例值:true
ErrMessagestring

错误信息。

示例值:The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划 ID。

示例值:dbs1h****usfa
NeedPrecheckboolean

本次修改是否会触发预检查,如果为 true 则需要再调用 StartBackupPlan 接口启动备份计划。

示例值:false
变更历史
暂无变更历史