MongoDB の DescribeBackupDBs API 概要 - ApsaraDB for MongoDB

操作説明

CreateDBInstance 操作を呼び出して、ApsaraDB for MongoDB インスタンスのデータベースを復元できます。詳細については、「ApsaraDB for MongoDB インスタンスの単一データベースの復元」をご参照ください。

この操作を呼び出す前に、インスタンスが次の要件を満たしていることを確認してください。

インスタンスは 2019 年 3 月 26 日以降に作成されていること。
インスタンスが、中国 (青島)、中国 (北京)、中国 (張家口)、中国 (フフホト)、中国 (杭州)、中国 (上海)、中国 (深セン)、またはシンガポールのリージョンに存在すること。他のリージョンはサポートされていません。
インスタンスがレプリカセットインスタンスであること。
インスタンスが MongoDB 3.4、MongoDB 4.0、または MongoDB 4.2 を実行していること。さらに、インスタンスはローカルディスクを使用してデータを保存していること。
インスタンスのストレージエンジンが WiredTiger であること。

今すぐお試しください

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

get

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	任意	返されるページ番号。0 より大きい整数である必要があります。デフォルト値：1。	1
PageSize	integer	任意	1 ページあたりのエントリ数。デフォルト値：30。有効な値：30、50、100。	30
SourceDBInstance	string	必須	ソースインスタンスの ID。	dds-bp2286****
RestoreTime	string	任意	インスタンスを復元するポイントインタイム。時間は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 標準で指定する必要があります。時間は UTC である必要があります。説明過去 7 日以内のポイントインタイムを指定できます。時間は、現在時刻より前で、かつインスタンスの作成時刻より後である必要があります。 RestoreTime と BackupId のいずれかのパラメーターを指定する必要があります。	2019-08-22T12:00:00Z
BackupId	string	任意	バックアップ ID。説明 DescribeBackups 操作を呼び出して、バックアップ ID を照会できます。 RestoreTime と BackupId のいずれかのパラメーターを指定する必要があります。	5664****
ResourceGroupId	string	任意	リソースグループの ID。	rg-ax68****
SourceDBInstance	string	必須	ソースインスタンスの ID。	dds-bp2286****

レスポンスフィールド

フィールド	型	説明	例
	object
TotalCount	integer	返されたデータベースの数。	5
Databases	object
Database	array<object>	データベースの詳細。
	object
DBName	string	データベースの名前。	mongodbtest
RequestId	string	リクエスト ID。	1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455
PageSize	integer	1 ページあたりのエントリ数。	30
PageNumber	integer	返されたページ番号。	1

例

成功レスポンス

JSONJSON

{
  "TotalCount": 5,
  "Databases": {
    "Database": [
      {
        "DBName": "mongodbtest"
      }
    ]
  },
  "RequestId": "1AF0AD89-ED4F-44AD-B65F-BFC1D5CD9455",
  "PageSize": 30,
  "PageNumber": 1
}

エラーコード

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.

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

変更履歴

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