すべてのプロダクト
Search

このプロダクト

    :DescribeDownloadTask

    ドキュメントセンター

    :DescribeDownloadTask

    最終更新日:Dec 02, 2025

    ApsaraDB RDS for MySQL、ApsaraDB RDS for PostgreSQL、および PolarDB for MySQL インスタンスの高度なダウンロードタスクのリストを照会します。

    操作説明

    適用エンジン

    • クラウドディスクを使用する ApsaraDB RDS for MySQL インスタンス

    • ApsaraDB RDS for PostgreSQL

    • PolarDB for MySQL

    • MongoDB

    関連ドキュメント

    今すぐお試しください

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

    get

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionCode

    string

    必須

    インスタンスが属するリージョンの ID。リージョン ID を取得するには、DescribeDBInstanceAttribute を呼び出します。

    cn-hangzhou
    InstanceName

    string

    任意

    インスタンス ID。

    説明

    このパラメーターは必須です。

    rm-bp1imnmcjxdz7****
    DatasourceId

    string

    任意

    DBS 内のデータソースの ID。フォーマットは ds-${Instance ID}_${Region ID} です。

    ds-rm-2ze8g2am97624****_cn-hangzhou
    BackupSetId

    string

    任意

    バックアップセットの ID。バックアップセット ID を取得するには、DescribeBackups を呼び出します。

    216****
    State

    string

    任意

    ダウンロードタスクの状態。有効値：

    • initializing：タスクは初期化中です。

    • queueing：タスクはキューイング中です。

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

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

    • finished：タスクは成功しました。

    • expired：ダウンロードは期限切れです。

    queueing
    TaskType

    string

    任意

    ダウンロードタスクのタイプ。有効値：

    • full：完全バックアップセットのダウンロード。

    • pitr：ポイントインタイムリカバリのダウンロード。

    full
    StartTime

    string

    任意

    作成時刻に基づいてタスクを照会する時間範囲の開始時刻。これはミリ秒 (ms) 単位の UNIX タイムスタンプです。

    1661941554000
    EndTime

    string

    任意

    作成時刻に基づいてタスクを照会する時間範囲の終了時刻。これはミリ秒 (ms) 単位の UNIX タイムスタンプです。

    1661941556000
    PageSize

    string

    任意

    各ページに返すエントリ数です。

    50
    CurrentPage

    string

    任意

    ページ番号。

    1
    OrderDirect

    string

    任意

    ソート順。有効値：

    • asc：昇順。

    • desc：降順。これはデフォルト値です。

    desc
    OrderColumn

    string

    任意

    ソートに使用するフィールド。デフォルト値は gmt_create で、作成時刻を示します。

    gmt_create
    ClusterName

    string

    任意

    シャードクラスターの名前。このパラメーターは MongoDB インスタンスにのみ必須です。

    dds-example

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるパラメーター。

    RequestId

    string

    リクエスト ID。

    5D285EB9-A443-592D-9F3D-A888FAC3****
    ErrCode

    string

    エラーコード。

    DBS.InternalError
    Success

    string

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

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

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

    true
    ErrMessage

    string

    エラーメッセージ。

    instanceName can not be empty
    Code

    string

    エラーコード。

    DBS.InternalError
    Message

    string

    エラーメッセージ。

    instanceName can not be empty
    Data

    object

    タスク詳細。

    PageNumber

    integer

    ページ番号。0 より大きく、integer データ型の最大値を超えない必要があります。デフォルト値：1。

    1
    TotalPages

    integer

    総ページ数。

    2
    Extra

    string

    データをクラウドにバックアップするために使用されるタスクに関する追加情報。

    dbtest
    TotalElements

    integer

    ダウンロードタスクの総数。

    1
    PageSize

    integer

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

    10
    Content

    object

    List

    array<object>

    タスク詳細。

    object

    タスク詳細。

    TaskId

    string

    ダウンロードタスク ID。

    dt-qxntlvgu****
    RegionCode

    string

    リージョン ID。

    cn-hangzhou
    Format

    string

    ダウンロードしたデータが変換される先のフォーマット。有効値：

    • csv

    • SQL

    • Parquet

    csv
    DbList

    string

    データベースのリスト。

    [dbtest]
    BakSetId

    string

    完全バックアップセットの ID。

    148261****
    DownloadStatus

    string

    ダウンロードタスクの状態。有効値：

    • initializing：タスクは初期化中です。

    • queueing：タスクはキューイング中です。

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

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

    • finished：タスクは成功しました。

    • expired：ダウンロードは期限切れです。

    queueing
    ExportDataSize

    string

    エクスポートされたデータの量 (バイト単位)。

    0
    ImportDataSize

    string

    処理されたデータの量 (バイト単位)。

    0
    BackupSetTime

    string

    ポイントインタイムダウンロードタスクの特定時点。これはミリ秒 (ms) 単位の UNIX タイムスタンプです。

    1663162216000
    TargetType

    string

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

    • OSS

    • URL

    URL
    TargetPath

    string

    ダウンロードされたデータの宛先パス。このパラメーターは、TargetType が OSS に設定されている場合に返されます。

    test_db/path
    Progress

    string

    エクスポートされたテーブル数/エクスポート対象の総テーブル数。

    0/0
    GmtCreate

    string

    タスクが作成された時刻。これはミリ秒単位の UNIX タイムスタンプです。

    1663321957000

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": {
      "List": [
        {
          "TaskId": "dt-qxntlvgu****",
          "RegionCode": "cn-hangzhou",
          "Format": "csv",
          "DbList": "[dbtest]",
          "BakSetId": "148261****",
          "DownloadStatus": "queueing",
          "ExportDataSize": "0",
          "ImportDataSize": "0",
          "BackupSetTime": "1663162216000",
          "TargetType": "URL",
          "TargetPath": "test_db/path",
          "Progress": "0/0",
          "GmtCreate": "1663321957000"
        }
      ]
    }
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    403 Request.Forbidden Have no Permissions

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

    変更履歴

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