すべてのプロダクト
Search

このプロダクト

    :ModifyBackupSourceEndpoint

    ドキュメントセンター

    :ModifyBackupSourceEndpoint

    最終更新日:Dec 01, 2025

    データベースバックアップソースエンドポイントを変更します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:ModifyBackupSourceEndpoint

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    必須

    バックアッププランの ID。DescribeBackupPlanList 操作を呼び出して ID を取得します。

    dbs1h****usfa
    SourceEndpointInstanceType

    string

    必須

    データベースの場所。DescribeBackupPlanList 操作を呼び出してこの値を取得します。有効値：

    • RDS

    • ECS

    • Express：専用回線、VPN Gateway、または Smart Access Gateway を介して接続されたデータベース。

    • Agent：バックアップゲートウェイを介して接続されたデータベース。

    • DDS：MongoDB

    • Other：IP アドレスとポートを使用して直接接続されたデータベース。

    RDS
    SourceEndpointRegion

    string

    任意

    データベースが配置されているリージョン。DescribeBackupPlanList 操作を呼び出してこの値を取得します。

    説明

    このパラメーターは、SourceEndpointInstanceType が RDS、ECS、DDS、Express、または Agent に設定されている場合に必須です。

    cn-hangzhou
    SourceEndpointInstanceID

    string

    任意

    データベースインスタンスの ID。DescribeBackupPlanList 操作を呼び出してこの ID を取得します。

    説明

    このパラメーターは、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 の場合、このパラメーターは必須です。

    • SourceEndpointInstanceType が Agent に設定され、データベースタイプが MSSQL の場合、このパラメーターは必須です。

    test
    SourceEndpointUserName

    string

    任意

    データベースアカウント。DescribeBackupPlanList 操作を呼び出してこの値を取得します。

    データベースタイプが Redis の場合、または SourceEndpointInstanceType が Agent に設定され、データベースタイプが MSSQL の場合、このパラメーターはオプションです。他のすべてのシナリオでは、このパラメーターは必須です。

    test
    SourceEndpointPassword

    string

    任意

    パスワード。

    データベースタイプが Redis の場合、または SourceEndpointInstanceType が Agent に設定され、データベースタイプが MSSQL の場合、このパラメーターはオプションです。他のすべてのシナリオでは、このパラメーターは必須です。

    test
    BackupGatewayId

    integer

    任意

    バックアップゲートウェイの ID。DescribeBackupPlanList 操作を呼び出してこの ID を取得します。

    説明

    このパラメーターは、SourceEndpointInstanceType が Agent に設定されている場合に必須です。

    21321323213
    BackupObjects

    string

    任意

    バックアップオブジェクト。SourceEndpointInstanceType が Agent に設定されている場合、このパラメーターはオプションです。他のすべてのシナリオでは、このパラメーターは必須です。DescribeBackupPlanList 操作を呼び出してこの値を取得します。

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

    string

    任意

    Oracle システム ID (SID)。データベースタイプが Oracle の場合、このパラメーターは必須です。

    test
    CrossAliyunId

    string

    任意

    クロスアカウントバックアップ用の Alibaba Cloud アカウントの UID。DescribeRestoreTaskList 操作を呼び出してこの UID を取得します。

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    任意

    クロスアカウントバックアップ用の RAM ロールの名前。DescribeRestoreTaskList 操作を呼び出してこの名前を取得します。

    test123
    ClientToken

    string

    任意

    リクエストのべき等性を保証する文字列。これにより、リクエストの再送信を防ぎます。

    ETnLKlblzczshOTUbOCzxxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。