DescribeBackupTasks を使用したバックアップジョブのクエリ - MongoDB

クラウドディスクを使用する MongoDB ReplicaSet またはシャードクラスターインスタンスの進行中のバックアップジョブを照会します。

今すぐお試しください

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

none

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。	dds-2zeb2d64cb46xxxx
BackupJobId	string	任意	バックアップジョブ ID。説明 CreateBackup を呼び出して手動バックアップを実行する場合、返されたバックアップ ID を渡してバックアップの進捗を照会できます。	170034

レスポンスフィールド

フィールド	型	説明	例
	object	応答本文。
RequestId	string	リクエスト ID。	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>	バックアップジョブの詳細。
	object	バックアップジョブの詳細。
BackupjobId	string	バックアップジョブ ID。	170034
BackupSetStatus	string	バックアップジョブのステータス。 Scheduled：バックアップジョブはスケジュール済みです。これには、まだ開始されていない定期的なバックアップジョブが含まれます。 Checking：バックアップ前にインスタンスがチェックされています。 Backuping：バックアップは進行中です。 Finished：バックアップは完了です。	Scheduled
BackupStartTime	string	バックアップの開始時刻。	2024-01-16T11:04:56Z
Progress	string	バックアップの進捗状況 (パーセンテージ)。進捗状況は、実行中のバックアップジョブに対してのみ表示されます。	18%
JobMode	string	バックアップモード。有効な値： Automated：自動バックアップ。 Manual：手動バックアップ。	Manual

例

成功レスポンス

JSONJSON

{
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": "170034\n",
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

エラーコード

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

変更履歴

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