すべてのプロダクト
Search
ドキュメントセンター

Data Management:ModifyBackupSourceEndpoint

最終更新日:Apr 24, 2026

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

今すぐお試しください

この 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

*BackupPlan

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

BackupPlanId

string

必須

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

dbs1h****usfa

SourceEndpointInstanceType

string

必須

ソースインスタンスのタイプ。DescribeBackupPlanList 操作を呼び出してこの値を取得できます。有効値:

  • RDS:RDS インスタンス

  • ECS:Elastic Compute Service (ECS) インスタンス上の自己管理データベース

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

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

  • DDS:ApsaraDB for MongoDB インスタンス

  • Other:IP アドレスとポートを介して接続されたデータベース

RDS

SourceEndpointRegion

string

任意

データベースリージョン。DescribeBackupPlanList 操作を呼び出してこの値を取得できます。

説明

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

cn-hangzhou

SourceEndpointInstanceID

string

任意

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

説明

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

rm-bp1p8c29479jv****

SourceEndpointIP

string

任意

データベースの IP アドレス。DescribeBackupPlanList 操作を呼び出してこの値を取得できます。

説明

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

100.*.*.10:3306

SourceEndpointPort

integer

任意

データベースのポート。DescribeBackupPlanList 操作を呼び出してこの値を取得できます。

説明

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

3306

SourceEndpointDatabaseName

string

任意

データベース名。

  • このパラメーターは、PostgreSQL および MongoDB データベースで必須です。

  • このパラメーターは、SourceEndpointInstanceType パラメーターが 'Agent' に設定されている場合、Microsoft SQL Server データベースでも必須です。

test

SourceEndpointUserName

string

任意

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

このパラメーターは、Redis および Microsoft SQL Server ('SourceEndpointInstanceType' パラメーターが 'Agent' に設定されている場合) を除くすべてのデータベースエンジンで必須です。

test

SourceEndpointPassword

string

任意

データベースアカウントのパスワード。

このパラメーターは、Redis および Microsoft SQL Server ('SourceEndpointInstanceType' パラメーターが 'Agent' に設定されている場合) を除くすべてのデータベースエンジンで必須です。

test

BackupGatewayId

integer

任意

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

説明

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

21321323213

BackupObjects

string

任意

バックアップオブジェクト:このパラメーターは、データベースがエージェント上にある場合はオプションですが、他のすべてのシナリオでは必須です。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/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

成功レスポンス

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

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

変更履歴

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