すべてのプロダクト
Search

このプロダクト

    :CheckRecoveryCondition

    ドキュメントセンター

    :CheckRecoveryCondition

    最終更新日:Dec 18, 2025

    ApsaraDB for MongoDB インスタンスのデータを復元できるかどうかを照会します。

    操作説明

    この操作は、レプリカセットインスタンスとシャードクラスターインスタンスに適用されます。

    説明

    この操作を呼び出してインスタンスのデータを復元できることを確認した後、CreateDBInstance 操作を呼び出して新しいインスタンスにデータを復元できます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:CheckRecoveryCondition

    get

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    SourceDBInstance

    string

    必須

    ソースインスタンスの ID。

    dds-bp1378****
    DatabaseNames

    string

    任意

    ソースデータベースの名前。値は JSON 配列です。

    説明

    このパラメーターを指定しない場合、デフォルトですべてのデータベースが復元されます。

    ["db1","db2"]
    RestoreTime

    string

    任意

    インスタンスを復元する時点。時間は ISO 8601 標準の yyyy-MM-ddTHH:mm:ssZ 形式で指定する必要があります。時間は UTC である必要があります。

    説明

    • 過去 7 日以内の時点を指定できます。指定する時間は、現在時刻より前で、インスタンスが作成された時刻より後である必要があります。

    • RestoreTime と BackupId パラメーターのいずれかを指定する必要があります。

    2022-08-22T08:00:00Z
    BackupId

    string

    任意

    バックアップ ID。

    説明

    • DescribeBackups 操作を呼び出して、バックアップ ID を照会できます。

    • RestoreTime と BackupId パラメーターのいずれかを指定する必要があります。

    • このパラメーターは、シャードクラスターインスタンスには適用されません。

    5664****
    ResourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID。

    sg-bp179****
    SourceDBInstance

    string

    必須

    ソースインスタンスの ID。

    dds-bp1378****
    SrcRegion

    string

    任意

    ソースインスタンスが存在するリージョン。

    説明

    • RestoreType パラメーターを 2 に設定する場合、このパラメーターは必須です。

    • RestoreType パラメーターを 3 に設定する場合、このパラメーターは必須です。

    cn-beijing
    DestRegion

    string

    任意

    リージョン間のバックアップと復元に使用されるバックアップセットのリージョン。

    説明

    RestoreType パラメーターを 3 に設定する場合、このパラメーターは必須です。

    cn-hangzhou
    RestoreType

    string

    任意

    復元タイプ。

    説明

    • 0：ソースインスタンスのデータは、同じリージョン内の新しいインスタンスに復元されます。

    • 1：ソースインスタンスのデータは、以前の時点に復元されます。

    • 2：削除されたインスタンスのデータは、バックアップセットから新しいインスタンスに復元されます。

    • 3：削除されたインスタンスのデータは、バックアップセットから別のリージョン内の新しいインスタンスに復元されます。

    0
    InstanceType

    string

    任意

    インスタンスアーキテクチャ。有効値：

    • replicate

    • sharding

    説明

    • RestoreType パラメーターを 2 に設定する場合、このパラメーターは必須です。

    • RestoreType パラメーターを 3 に設定する場合、このパラメーターは必須です。

    replicate
    EngineVersion

    string

    任意

    インスタンスのデータベースエンジンバージョン。

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返される情報。

    RequestId

    string

    リクエスト ID。

    D563A3E7-6010-45FE-A0CD-9283414C9657
    DBInstanceName

    string

    インスタンス ID

    dds-bp1378****
    IsValid

    boolean

    インスタンスのデータを復元できるかどうかを示します。有効値：

    • true：インスタンスのデータを復元できます。

    • false：インスタンスのデータを復元できません。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "D563A3E7-6010-45FE-A0CD-9283414C9657",
  "DBInstanceName": "dds-bp1378****",
  "IsValid": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidMeta.WrongFormat Meta information is wrong formatter.
    400 InvalidRestoreTime.Format Specified restore time is not valid.
    403 InvalidDBName The specified database name is not allowed.
    403 InvalidMeta.TooLarge Meta information is too large.
    403 SingleDBRestore.BackupSetNotSupport This backup set do not support this operation.
    403 IncorrectDBInstanceType Current DB instance type does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    403 InvalidBackupLogStatus Current backup log enable status does not support this operation.
    403 IncorrectBackupSetState Current backup set state does not support operations..
    404 InvalidBackupSetID.NotFound Specifiedbackup set ID does not exist.
    404 InvalidBackup.NotFound Theavailable backup does not exist in recovery time.

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

    変更履歴

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