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

:ModifyBackupObjects

最終更新日:Dec 01, 2025

Database Backup Service (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:ModifyBackupObjects

update

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

BackupPlanId

string

必須

バックアッププランの ID です。

dbs1h****usfa

BackupObjects

string

必須

バックアップオブジェクトを JSON 文字列で指定します。フォーマットは次のとおりです。

[
    {
        "DBName":"バックアップするデータベース名",
        "SchemaName":"バックアップするスキーマ名",
        "TableIncludes":[{
        	"TableName":"バックアップするテーブル名"
        }],
        "TableExcludes":[{
            "TableName":"バックアップが不要なデータベース内のテーブル名"
        }]
    }
]
  • DBName のみが指定され、他のサブオブジェクトにルールが設定されていない場合、データベース内のすべてのオブジェクトがバックアップされます。

  • DBName が指定され、一部のオブジェクトにルールが設定されている場合、ルールが設定されていないオブジェクトはデフォルトではバックアップされません。オブジェクト名は、次の正規表現を使用して定義できます。
    • ピリオド (.) は、\r\n を除く任意の 1 文字に一致します。

    • アスタリスク (*) は、直前の部分式が 0 回以上繰り返される場合に一致します。たとえば、h*llohlloheeeello などの文字列に一致します。

    • 疑問符 (?) は、直前の部分式が 0 回または 1 回出現する場合に一致します。たとえば、h.?llohllohello には一致しますが、haello には一致しません。

    • 文字セット ([characters]) は、角括弧内の任意の 1 文字に一致します。たとえば、h[aello]hallohello に一致します。

    • 否定文字セット ([^characters]) は、角括弧内にない任意の 1 文字に一致します。たとえば、h[^ae]llohcllohdllo には一致しますが、hallohello には一致しません。

    • 文字範囲 ([character1-character2]) は、[0-9][a-z] のように、指定された範囲内の任意の文字に一致します。

説明

SchemaNameNewSchemaName は MSSQL でのみ使用されます。他のデータベースでは、DBNameNewDBName パラメーターを使用してデータベース名を定義します。

[ { "DBName":"17xxx92xxxx374", "SchemaName":"gy9xnj8xxxxxx", "TableIncludes":[{ "TableName":"test1" }], "TableExcludes":[{ "TableName":"test2" }] } ]

ClientToken

string

任意

リクエストのべき等性を保証するためのクライアントトークンです。これにより、同じリクエストが複数回送信されるのを防ぎます。

ETnLKlblzczshOTUbOCzxxxxxxx

レスポンスフィールド

フィールド

説明

object

返されるパラメーターの詳細です。

HttpStatusCode

integer

HTTP ステータスコードです。

200

RequestId

string

リクエスト ID です。

D6E068C3-25BC-455A-85FE-45F0B22ECB1F

ErrCode

string

エラーコードです。

InvalidParameter

Success

boolean

リクエストが成功したかどうかを示します。戻り値は次のとおりです。

  • true:リクエストは成功しました。

  • false:リクエストは失敗しました。

true

ErrMessage

string

エラーメッセージです。

The specified parameter %s value is not valid.

BackupPlanId

string

バックアッププランの ID です。

dbs1h****usfa

NeedPrecheck

boolean

変更によって事前チェックがトリガーされるかどうかを示します。値が true の場合、StartBackupPlan 操作を呼び出してバックアッププランを開始する必要があります。

true

成功レスポンス

JSONJSON

{
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "InvalidParameter",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "BackupPlanId": "dbs1h****usfa",
  "NeedPrecheck": true
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

403 Request.Forbidden Have no Permissions

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

変更履歴

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