该接口用于修改数据库备份源。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dbs:ModifyBackupSourceEndpoint | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
BackupPlanId | string | 是 | 备份计划 ID,可通过调用 DescribeBackupPlanList 接口获取该参数的值。 | dbs1h****usfa |
SourceEndpointInstanceType | string | 是 | 数据库所在位置,可通过调用 DescribeBackupPlanList 接口获取该参数的值。取值如下:
| 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 | 否 | 数据库名称。
| test |
SourceEndpointUserName | string | 否 | 数据库账号,可通过调用 DescribeBackupPlanList 接口获取该参数的值。 数据库类型为 Redis,或者数据库所在位置为 Agent 且数据库类型为 MSSQL 时该参数非必须,其他场景均必传。 | test |
SourceEndpointPassword | string | 否 | 密码。 数据库类型为 Redis,或者数据库所在位置为 Agent 且数据库类型为 MSSQL 时该参数非必须,其他场景均必传。 | test |
BackupGatewayId | long | 否 | 备份网关 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,可通过调用 DescribeRestoreTaskList 接口获取该参数的值。 | 2xxx7778xxxxxxxxxx |
CrossRoleName | string | 否 | 跨阿里云账号备份的 RAM 角色名称,可通过调用 DescribeRestoreTaskList 接口获取该参数的值。 | test123 |
ClientToken | string | 否 | 任意字符串,用于保证请求的幂等性,防止重复提交请求。 | ETnLKlblzczshOTUbOCzxxxxxxx |
返回参数
示例
正常返回示例
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控制台进行授权后再执行操作 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|