すべてのプロダクト
Search

このプロダクト

    Data Management:DescribeBackupSetDownloadTaskList

    ドキュメントセンター

    Data Management:DescribeBackupSetDownloadTaskList

    最終更新日:Jan 13, 2026

    Database Backup Service (DBS) のバックアップセットのダウンロードタスクのリストを照会します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dbs:DescribeBackupSetDownloadTaskList

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    BackupPlanId

    string

    任意

    バックアッププランの ID。DescribeBackupPlanList 操作を呼び出して、このパラメーターの値を取得します。

    説明

    BackupPlanId または BackupSetDownloadTaskId のいずれかを指定する必要があります。

    dbsqhnuhyw3****
    BackupSetDownloadTaskId

    string

    任意

    バックアップセットのダウンロードタスクの ID。

    • 完全バックアップの場合は、CreateFullBackupSetDownload 操作を呼び出して、このパラメーターの値を取得します。

    • 増分バックアップの場合は、CreateIncrementBackupSetDownload 操作を呼び出して、このパラメーターの値を取得します。

    urxgrxt7****
    PageSize

    integer

    任意

    各ページに返すエントリ数。有効値：30、50、100。

    説明

    デフォルト値は 30 です。

    30
    PageNum

    integer

    任意

    ページ番号。値は、整数型の最大値を超えない非負の整数である必要があります。デフォルト値は 0 です。

    1
    ClientToken

    string

    任意

    リクエストのべき等性を保証するために使用されるクライアントトークン。これにより、重複したリクエストを防ぐことができます。

    ETnLKlblzczshOTUbOCzXXXXXX

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されたパラメーターの詳細。

    HttpStatusCode

    integer

    HTTP ステータスコード。

    200
    PageNum

    integer

    ページ番号。

    0
    RequestId

    string

    リクエスト ID。

    6DC3D286-E0E6-5988-A558-2184984B****
    ErrCode

    string

    エラーコード。

    Param.NotFound
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    ErrMessage

    string

    エラーメッセージ。

    The specified parameter %s value is not valid.
    TotalPages

    integer

    総ページ数。

    1
    TotalElements

    integer

    バックアップセットのダウンロードレコードの総数。

    1
    PageSize

    integer

    1ページあたりに返されるエントリ数。

    30
    Items

    object

    BackupSetDownloadTaskDetail

    array<object>

    バックアップセットのダウンロードタスクの詳細。

    object

    バックアップセットのダウンロードタスクの詳細。

    BackupSetDownloadStatus

    string

    バックアップセットのダウンロードステータス。有効な値：

    • checking：タスクは事前チェック中です。

    • init：事前チェックに失敗し、タスクは開始されていません。

    • check_pass：事前チェックに合格しました。

    • pause：タスクは一時停止しています。

    • schedule：タスクはスケジューリング待ちです。

    • running：タスクは実行中です。

    • stop：タスクは失敗しました。

    • finish：タスクは完了しました。

    finish
    BackupSetDataSize

    integer

    バックアップセットデータのサイズ。

    237837
    BackupSetDownloadTargetType

    string

    バックアップセットのダウンロード先タイプ。

    説明

    このパラメーターは自動ダウンロードの場合にのみ表示されます。値 `agent` は、バックアップゲートウェイがインストールされていることを示します。

    无
    BackupSetDownloadDir

    string

    バックアップセットがダウンロードされるサーバー上のディレクトリ。

    説明

    このパラメーターは自動ダウンロードの場合にのみ値があります。

    无
    ErrMessage

    string

    エラーメッセージ。

    java.lang.IndexOutOfBoundsException.
    BackupSetDownloadCreateTime

    integer

    タスクが作成された日時を示す UNIX タイムスタンプ。

    1642044001000
    BackupPlanId

    string

    バックアッププランの ID。

    qhnuhyw3****
    BackupSetDbType

    string

    データベースタイプ。

    MySQL
    BackupSetDownloadInternetUrl

    string

    バックアップセットのパブリックネットワークダウンロード URL。

    説明

    このパラメーターは、フォーマット変換が完了した手動ダウンロードの場合にのみ値があります。

    "//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example"
    BackupSetId

    string

    ソースバックアップセットの ID。

    1h7za2yws****
    BackupSetDownloadIntranetUrl

    string

    バックアップセットの内部ダウンロード URL。

    説明

    このパラメーターは、フォーマット変換が完了した手動ダウンロードの場合にのみ値があります。

    "//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example"
    BackupGatewayId

    integer

    バックアップセットのバックアップゲートウェイ。このパラメーターは自動ダウンロードの場合にのみ値があります。

    无
    BackupSetDownloadWay

    string

    ダウンロードタイプ。有効な値：

    • manual：手動

    • auto：自動

    manual
    BackupSetDownloadFinishTime

    integer

    タスクが完了した日時を示す UNIX タイムスタンプ。

    1642044013000
    BackupSetJobType

    string

    ソースバックアップセットタスクのタイプ。有効な値：

    • cbs_backup_sub_full：論理完全バックアップタスク

    • cbs_backup_sub_cont：論理増分バックアップタスク

    cbs_backup_sub_cont
    BackupSetDownloadTaskId

    string

    バックアップセットのダウンロードタスクの ID。

    urxgrxt7****
    BackupSetDownloadTaskName

    string

    バックアップセットのダウンロードタスク名。

    1h7za2yws****-ManualCont
    BackupSetDataFormat

    string

    ダウンロードされたバックアップセットのデータ形式。有効な値：

    • Native

    • SQL

    • CSV

    • JSON

    Native
    BackupSetCode

    string

    ソースバックアップセットのエンコーディング。

    mysql-bin.00XXXX

    例

    成功レスポンス

    JSONJSON

    {
  "HttpStatusCode": 200,
  "PageNum": 0,
  "RequestId": "6DC3D286-E0E6-5988-A558-2184984B****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": {
    "BackupSetDownloadTaskDetail": [
      {
        "BackupSetDownloadStatus": "finish",
        "BackupSetDataSize": 237837,
        "BackupSetDownloadTargetType": "无",
        "BackupSetDownloadDir": "无",
        "ErrMessage": "java.lang.IndexOutOfBoundsException.",
        "BackupSetDownloadCreateTime": 1642044001000,
        "BackupPlanId": "qhnuhyw3****",
        "BackupSetDbType": "MySQL",
        "BackupSetDownloadInternetUrl": "\"//dbs-137XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou.example\"",
        "BackupSetId": "1h7za2yws****",
        "BackupSetDownloadIntranetUrl": "\"//dbs-13XXXX-cn-hangzhou-1hr5cpbtmXXXX.oss-cn-hangzhou-internal.example\"",
        "BackupGatewayId": 0,
        "BackupSetDownloadWay": "manual",
        "BackupSetDownloadFinishTime": 1642044013000,
        "BackupSetJobType": "cbs_backup_sub_cont",
        "BackupSetDownloadTaskId": "urxgrxt7****",
        "BackupSetDownloadTaskName": "1h7za2yws****-ManualCont",
        "BackupSetDataFormat": "Native",
        "BackupSetCode": "mysql-bin.00XXXX"
      }
    ]
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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