すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeRestoreDBInstanceList

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeRestoreDBInstanceList

    最終更新日:Mar 26, 2026

    過去 7 日以内にバックアップから復元された ApsaraDB for MongoDB インスタンスを照会します。

    今すぐお試しください

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

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1ページあたりに返されるエントリ数。

    30
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bp114f14849d****
    CreationTimeAfter

    string

    必須

    指定した時刻以降に作成されたインスタンスを検索します。形式は yyyy-MM-ddTHH:00:00Z (UTC 時間) です。

    説明

    • 時刻は正時である必要があります。

    • 現在時刻より 7 日以上前の時刻は指定できません。

    2024-07-24T14:00:00Z

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    クエリ結果のインスタンス数。

    5
    RequestId

    string

    リクエスト ID。

    1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
    PageSize

    integer

    1ページあたりに返されるエントリ数。

    30
    PageNumber

    integer

    ページ番号。

    1
    DBInstances

    object

    DBInstance

    array<object>

    DB インスタンスのリスト。

    object

    DB インスタンスのリスト。

    CreationTime

    string

    インスタンスの作成時刻。形式は yyyy-MM-ddTHH:00:00Z (UTC 時間) です。

    2022-01-02T07:43:59Z
    LockMode

    string

    インスタンスのロック状態。値の説明：

    • Unlock：正常。

    • ManualLock：手動でトリガーされたロック。

    • LockByExpiration：期限切れによる自動ロック。

    • LockByRestoration：復元前の自動ロック。

    • LockByDiskQuota：ディスククォータ超過による自動ロック。

    Unlock
    EngineVersion

    string

    インスタンスのデータベースエンジンバージョン。有効な値：

    • 7.0

    • 6.0

    • 5.0

    • 4.4

    • 4.2

    • 4.0

    • 3.4

    4.2
    DBInstanceDescription

    string

    インスタンスの説明。

    Test database
    DBInstanceType

    string

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

    • sharding：シャードクラスターインスタンス

    • replicate：レプリカセットまたはスタンドアロンインスタンス

    replicate
    DBInstanceStatus

    string

    インスタンスのステータス。詳細については、「インスタンスのステータス」をご参照ください。

    Running
    RegionId

    string

    インスタンスのリージョン ID。

    cn-hangzhou
    ZoneId

    string

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

    cn-hangzhou-g
    DBInstanceId

    string

    インスタンス ID。

    dds-bp12c5b040dc****
    IsDeleted

    integer

    インスタンスが削除されているかどうかを示します。有効な値：

    • 0：削除されていません

    • 1：削除済み

    0

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 5,
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "DBInstances": {
    "DBInstance": [
      {
        "CreationTime": "2022-01-02T07:43:59Z",
        "LockMode": "Unlock",
        "EngineVersion": "4.2",
        "DBInstanceDescription": "Test database",
        "DBInstanceType": "replicate",
        "DBInstanceStatus": "Running",
        "RegionId": "cn-hangzhou",
        "ZoneId": "cn-hangzhou-g",
        "DBInstanceId": "dds-bp12c5b040dc****",
        "IsDeleted": 0
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter The specified parameter %s is not valid.
    400 InvalidDBInstanceId.NotFound Specified instance does not exist.

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

    変更履歴

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