すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeBackupTasks

最終更新日:Dec 11, 2025

クラスターのバックアップジョブのリストとその詳細を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeBackupTasks

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

DBClusterId

string

必須

クラスター ID。

pc-***************

BackupJobId

string

任意

バックアップジョブ ID。

11111111

BackupMode

string

任意

バックアップモード。有効な値:

  • Automated:自動バックアップ。

  • Manual:手動バックアップ。

Manual

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエスト ID。

FA8C1EF1-E3D4-44D7-B809-823187******

Items

object

BackupJob

array<object>

バックアップジョブの詳細。

object

StartTime

string

バックアップジョブの開始時間。時刻は協定世界時 (UTC) で、フォーマットは YYYY-MM-DDThh:mm:ssZ です。

2020-08-08T07:24:01Z

Process

string

バックアップジョブの進捗状況 (パーセンテージ)。

0

BackupJobId

string

バックアップジョブ ID。

11111111

JobMode

string

バックアップモード。有効な値:

  • Automated:自動バックアップ。

  • Manual:手動バックアップ。

Automated

BackupProgressStatus

string

バックアップジョブのステータス。有効な値:

  • NoStart:ジョブは開始されていません。

  • Preparing:ジョブは準備中です。

  • Waiting:ジョブは待機中です。

  • Uploading:バックアップはアップロード中です。

  • Checking:バックアップはチェック中です。

  • Finished:ジョブは完了しました。

NoStart

TaskAction

string

バックアップジョブのタイプ。有効な値:

  • TempBackupTask:一時的なバックアップジョブ。

  • NormalBackupTask:通常のバックアップジョブ。

NormalBackupTask

成功レスポンス

JSONJSON

{
  "RequestId": "FA8C1EF1-E3D4-44D7-B809-823187******",
  "Items": {
    "BackupJob": [
      {
        "StartTime": "2020-08-08T07:24:01Z",
        "Process": "0",
        "BackupJobId": "11111111",
        "JobMode": "Automated",
        "BackupProgressStatus": "NoStart",
        "TaskAction": "NormalBackupTask"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidDBClusterId.NotFound The DBClusterId provided does not exist in our records.
400 InvalidBackupMode.Malformed The specified parameter BackupMode is not valid.

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

変更履歴

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