すべてのプロダクト
Search

このプロダクト

    AnalyticDB:DescribeBackupJob

    ドキュメントセンター

    AnalyticDB:DescribeBackupJob

    最終更新日:Mar 21, 2026

    バックアップジョブの情報をクエリします。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:DescribeBackupJob

    get

    *DBInstance

    acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    説明

    DescribeDBInstances 操作を呼び出して、リージョン内のすべての AnalyticDB for PostgreSQL インスタンスの情報 (インスタンス ID を含む) をクエリできます。

    gp-xxxxxxxxx
    BackupJobId

    integer

    必須

    バックアップジョブ ID。

    123

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    BackupJobId

    string

    バックアップジョブ ID。

    123
    BackupId

    string

    バックアップセット ID。

    説明

    DescribeDataBackups 操作を呼び出して、インスタンス内のすべてのバックアップセットの ID をクエリできます。

    1111111111
    BackupMode

    string

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

    • Automated

    • Manual

    Automated
    BackupStatus

    string

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

    • schedule

    • check

    • backup

    • finish

    backup
    Process

    string

    バックアップジョブの進捗。

    50%
    StartTime

    string

    バックアップジョブの開始時間。時刻は、ISO 8601 標準に準拠した YYYY-MM-DDThh:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。

    2023-01-03T16:00:00Z

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "BackupJobId": "123",
  "BackupId": "1111111111",
  "BackupMode": "Automated",
  "BackupStatus": "backup",
  "Process": "50%",
  "StartTime": "2023-01-03T16:00:00Z"
}

    エラーコード

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

    変更履歴

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