DescribeBackupTasks操作を呼び出して、ApsaraDB RDSインスタンスのバックアップタスクを照会できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目 データ型 必須／任意 例: 説明　
操作 String 必須 DescribeBackupTasks

実行したい操作。 値をDescribeBackupTasksに設定します。
DBInstanceId String 必須 rm-uf6wjk5xxxxxxx

インスタンスの ID です。
ClientToken String 任意 ETnLKlblzczshOTUbOCzxxxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意である必要があります。 トークンにはASCII文字のみを使用でき、長さは64文字を超えることはできません。
フラグ String 任意 なし

非表示のパラメーター。
BackupJobId Integer いいえ 4762614

照会する単一のバックアップタスクのID。
BackupMode String 任意 Automated

照会するバックアップタスクによって使用されるバックアップモード。 有効な値：

  • 自動化
  • 手動
BackupJobStatus String 任意 NoStart

照会するバックアップタスクのステータス。 有効な値：

  • NoStart: 未開始のバックアップタスクを照会します。
  • Progressing: 進行中のバックアップタスクを照会することを指定します。

既定では、この操作は両方の状態のバックアップタスクを返します。

レスポンスパラメーター

項目 データ型 例: 説明　
項目 BackupJobの配列

バックアップタスクで構成される配列。
BackupJob
BackupId String 346650271

バックアップタスクによって生成されるバックアップセットのID。

説明 BackupStatusパラメーターの戻り値がFinishedの場合、BackupJobIdパラメーターを指定して、生成されたバックアップセットのIDを取得する必要があります。
BackupJobId String 4762614

バックアップタスクのID。
BackupProgressStatus String NoStart

バックアッププログラムのステータス。 有効な値：

  • NoStart: バックアッププログラムが起動していません。
  • Preparing: バックアッププログラムはバックアップの準備をしています。
  • Waiting: バックアッププログラムは待機中です。
  • Uploading: バックアッププログラムがバックアップファイルをアップロード中です。
  • Checking: バックアッププログラムはアップロードされたバックアップファイルをチェックしています。
  • Finished: バックアッププログラムがバックアップを完了しました。
BackupStatus String NoStart

バックアップタスクのステータス。 有効な値：

  • NoStart: バックアップタスクが開始されていません。
  • 確認中: バックアップタスクはバックアップ設定を確認しています。
  • Preparing: バックアップタスクはバックアップの準備中です。
  • 待機中: バックアップタスクは待機中です。
  • Uploading: バックアップタスクはバックアップファイルをアップロードしています。
  • 完了: バックアップタスクは完了です。
  • 失敗バックアップタスクが失敗しました。
説明 このパラメーターは、バックアップタスクが実行された場合にのみ返されます。
JobMode String Automated

バックアップタスクのバックアップモード。 有効な値：

  • 自動化
  • 手動
処理中 String 25

バックアップタスクの進行状況。 単位: % 。
TaskAction String NormalBackupTask

バックアップタスクのタイプ。 有効な値：

  • TempBackupTask: 一時バックアップタスク
  • NormalBackupTask: 通常のバックアップタスク
RequestId String 90496720-2319-42A8-87CD-FCE4DF95EBED

リクエストの ID です。

例

リクエストの例

http(s)://rds.aliyuncs.com/? アクション=DescribeBackupTasks
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<DescribeBackupTasksResponse>
<アイテム>
<BackupJob>
<JobMode> 自動化 </JobMode>
<BackupProgressStatus>NoStart</BackupProgressStatus>
<TaskAction>NormalBackupTask</TaskAction>
<BackupStatus>NoStart</BackupStatus>
<BackupJobId>4762614</BackupJobId>
</BackupJob>
</アイテム>
<RequestId>90496720-2319-42A8-87CD-FCE4DF95EBED</RequestId>
</DescribeBackupTasksResponse>

JSON 形式

{
    "Items": {
        "BackupJob": [
            {
                "JobMode": "自動化" 、
                "BackupProgressStatus": "NoStart" 、
                "TaskAction": "NormalBackupTask" 、
                "BackupStatus": "NoStart" 、
                "BackupJobId": 4762614
            }
        ]
    },
    "RequestId": "90496720-2319-42A8-87CD-FCE4DF95EBED"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。