ModifyBackupSourceEndpoint - 修改数据库备份源

调用ModifyBackupSourceEndpoint接口,修改数据库备份源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dbs:ModifyBackupSourceEndpointRead

    请求参数

    名称类型必填描述示例值
    BackupPlanIdstring

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

    dbs1h****usfa
    SourceEndpointInstanceTypestring

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

    • RDS
    • ECS
    • Express:通过专线/VPN网关/智能网关接入的数据库
    • Agent:通过备份网关接入的数据库
    • DDS:云MongoDB
    • Other:通过IP:Port直连的数据库
    RDS
    SourceEndpointRegionstring

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

    说明SourceEndpointInstanceType为RDS、ECS、DDS、Express、Agent时,该参数必传。
    cn-hangzhou
    SourceEndpointInstanceIDstring

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

    说明SourceEndpointInstanceType为RDS、ECS、DDS、Express时,该参数必传。
    rm-bp1p8c29479jv****
    SourceEndpointIPstring

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

    说明SourceEndpointInstanceType为Express、Agent、Other时该参数必传。
    100.*.*.10:3306
    SourceEndpointPortinteger

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

    说明SourceEndpointInstanceType为Express、Agent、Other、ECS,该参数必传。
    3306
    SourceEndpointDatabaseNamestring

    数据库名称。

    • 数据库类型为PostgreSQL、MongoDB时,该参数必传。
    • 数据库所在位置为Agent且数据库类型为MSSQL时,该参数必传。
    test
    SourceEndpointUserNamestring

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

    数据库类型为Redis,或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。

    test
    SourceEndpointPasswordstring

    密码。

    数据库类型为Redis,或者数据库所在位置为Agent且数据库类型为MSSQL时该参数非必须,其他场景均必传。

    test
    BackupGatewayIdLong

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

    说明SourceEndpointInstanceType为Agent时,该参数必传。
    21321323213
    BackupObjectsstring

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

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

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

    test
    CrossAliyunIdstring

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

    2xxx7778xxxxxxxxxx
    CrossRoleNamestring

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

    test123
    ClientTokenstring

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

    ETnLKlblzczshOTUbOCzxxxxxxx

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP状态码。

    200
    RequestIdstring

    请求ID。

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

    错误码。

    Param.NotFound
    Successboolean

    请求是否成功,返回值如下:

    • true:请求成功
    • false:请求失败
    true
    ErrMessagestring

    错误信息。

    The specified parameter %s value is not valid.
    BackupPlanIdstring

    备份计划ID。

    dbs1h****usfa
    NeedPrecheckboolean

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

    false

    示例

    请求示例

    http(s)://dbs-api.cn-hangzhou.aliyuncs.com/?Action=ModifyBackupSourceEndpoint
    &BackupPlanId=dbs1h****usfa
    &SourceEndpointInstanceType=RDS
    &<公共请求参数>
    

    正常返回示例

    JSON格式

    {
      "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22E****",
      "HttpStatusCode": 200,
      "BackupPlanId": "dbs1h****usfa",
      "NeedPrecheck": false,
      "Success": true
    }

    XML格式

    <ModifyBackupSourceEndpointResponse>
        <RequestId>D6E068C3-25BC-455A-85FE-45F0B22E****</RequestId>
        <HttpStatusCode>200</HttpStatusCode>
        <BackupPlanId>dbs1h****usfa</BackupPlanId>
        <NeedPrecheck>false</NeedPrecheck>
        <Success>true</Success>
    </ModifyBackupSourceEndpointResponse>

    错误码

    访问错误中心查看更多错误码。

    阿里云首页 数据库备份 DBS 相关技术圈