すべてのプロダクト
Search

このプロダクト

    :CreateDownload

    ドキュメントセンター

    :CreateDownload

    最終更新日:Dec 02, 2025

    高度なダウンロードタスクを作成します。

    操作説明

    適用エンジン

    • RDS MySQL (クラウドディスク)

    • RDS PostgreSQL

    • PolarDB for MySQL

    • MongoDB

    関連ドキュメント

    対象のインスタンスに対して、特定時点または特定のバックアップセットの高度なダウンロードタスクを作成できます。データを URL にダウンロードしたり、Object Storage Service (OSS) バケットに直接書き込んでデータ分析やオフラインアーカイブに利用したりできます。

    今すぐお試しください

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

    create

    *DBInstance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionCode

    string

    必須

    インスタンスが存在するリージョンの ID。RDS インスタンスの場合は DescribeDBInstanceAttribute 操作を、PolarDB クラスターの場合は DescribeDBClusterAttribute 操作を呼び出して、リージョン ID をクエリできます。

    cn-beijing
    InstanceName

    string

    必須

    インスタンス ID。

    rm-wz994c1t1****
    BakSetType

    string

    任意

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

    • full：完全なバックアップセットをダウンロードします。

    • pitr：特定時点のデータをダウンロードします。

    full
    BakSetId

    string

    任意

    バックアップセットの ID。RDS インスタンスの場合は DescribeBackups 操作を、PolarDB クラスターの場合は DescribeBackups 操作を呼び出して、このパラメーターをクエリできます。

    説明

    このパラメーターは、BakSetType が full に設定されている場合に必須です。

    146005****
    DownloadPointInTime

    string

    任意

    データをダウンロードする特定時点。long データ型の UNIX タイムスタンプを指定します。単位：ミリ秒。

    説明

    このパラメーターは、BakSetType が pitr に設定されている場合に必須です。

    1661331864000
    BakSetSize

    string

    任意

    完全なバックアップセットのサイズ。RDS インスタンスの場合は DescribeBackups 操作を、PolarDB クラスターの場合は DescribeBackups 操作を呼び出して、サイズをクエリできます。単位：バイト。

    216****
    FormatType

    string

    任意

    ダウンロードしたデータを変換するフォーマット。有効な値：

    • CSV

    • SQL

    • Parquet

    説明

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

    CSV
    TargetType

    string

    任意

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

    • OSS

    • URL

    OSS
    TargetBucket

    string

    任意

    OSS バケットの名前。

    • このパラメーターは、TargetType が OSS に設定されている場合に必須です。

    • アカウントに AliyunDBSDefaultRole 権限があることを確認してください。権限の付与方法の詳細については、「RAM ロールへの権限付与」をご参照ください。プロンプトに従ってコンソールで権限を付与することもできます。

    test123
    TargetPath

    string

    任意

    データがダウンロードされる宛先パス。

    説明

    このパラメーターは、TargetType が OSS に設定されている場合に必須です。

    test_db/path
    TargetOssRegion

    string

    任意

    OSS バケットが存在するリージョン。

    説明

    このパラメーターは、TargetType が OSS に設定されている場合に必須です。

    cn-beijing
    PrimaryKeyTypeOnly

    string

    任意

    このフィールドは MongoDB インスタンスでのみ必須です。データベースとテーブルのプライマリキーの型が一意であるかどうかを示します。有効な値：true および false。

    false
    IsCluster

    string

    任意

    このフィールドは MongoDB インスタンスでのみ必須です。現在のインスタンスがシャードクラスターであるかどうかを示します。インスタンスがシャードクラスターの場合は、値を true に設定します。それ以外の場合は、値を false に設定します。

    false
    AdminDatabase

    string

    任意

    このフィールドは MongoDB インスタンスでのみ必須です。認証データベースの名前を指定します。デフォルト値は admin です。

    admin
    UseZstd

    string

    任意

    圧縮パッケージに zstd 圧縮アルゴリズムを使用するかどうかを示します。デフォルト値は false です。

    false
    ClusterName

    string

    任意

    このフィールドは MongoDB シャードクラスターでのみ必須です。シャードクラスターの ID を指定します。

    dds-0xid8e5336******
    IsPhysical

    boolean

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    戻り値。

    RequestId

    string

    リクエスト ID。

    A08F908D-2C35-583F-93C1-ED80753F****
    ErrCode

    string

    エラーコード。

    DBS.ParamIsInValid
    Success

    string

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

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

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

    true
    ErrMessage

    string

    エラーメッセージ。

    formatType can not be empty
    Code

    string

    ステータスコード。

    DBS.ParamIsInValid
    Message

    string

    エラーメッセージ。

    formatType can not be empty
    Data

    object

    返されたデータ。

    BakSetId

    string

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

    146005****
    DownloadStatus

    string

    ダウンロードタスクのステータス。有効な値：

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

    • queueing：タスクはキューに入っています。

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

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

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

    • expired：タスクは期限切れです。

    説明

    宛先が URL のタスクは、完了してから 3 日後に有効期限が切れます。

    initializing
    Progress

    string

    ダウンロードされたテーブル数/テーブルの総数。

    説明

    タスクが準備段階にある場合、0/0 が返されます。

    0/0
    BackupSetTime

    integer

    特定時点のダウンロードタスクの特定時点。値は UNIX タイムスタンプです。

    1661373070000
    RegionCode

    string

    リージョン ID。

    cn-beijing
    TargetPath

    string

    ダウンロードの宛先パス。

    説明

    このパラメーターは、TargetType が OSS に設定されている場合に返されます。

    test_db/path
    DbList

    string

    ダウンロードタスクが特定のデータベースとテーブルを対象としている場合、このフィールドはこれらのデータベースとテーブルに関する情報を返します。

    testdb
    ExportDataSize

    integer

    エクスポートされたデータのボリューム。単位：バイト。

    0
    ImportDataSize

    integer

    処理されたデータのボリューム。単位：バイト。

    0
    GmtCreate

    integer

    タスクが作成された時間。値は UNIX タイムスタンプです。

    1661940917570
    TaskId

    string

    ダウンロードタスクの ID。

    dt-qxnsfq5s****
    Format

    string

    データが変換されるフォーマット。

    CSV
    TargetType

    string

    ダウンロードの宛先タイプ。

    URL

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "A08F908D-2C35-583F-93C1-ED80753F****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "formatType can not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "formatType can not be empty",
  "Data": {
    "BakSetId": "146005****",
    "DownloadStatus": "initializing",
    "Progress": "0/0",
    "BackupSetTime": 1661373070000,
    "RegionCode": "cn-beijing",
    "TargetPath": "test_db/path",
    "DbList": "testdb",
    "ExportDataSize": 0,
    "ImportDataSize": 0,
    "GmtCreate": 1661940917570,
    "TaskId": "dt-qxnsfq5s****",
    "Format": "CSV",
    "TargetType": "URL"
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    200 DBS.DownloadTask.CannotFind Can not find download task.
    200 DBS.DownloadTask.JobAlreadyExist Job already submit in recent days, please check it.
    200 DBS.DownloadTask.OnlyOneRunningOrFailedTask There can be only one running or failed task for the instance.
    200 DBS.DownloadTask.OssForbid OSS is forbidden to access. Please check your OSS bucket.
    200 DBS.DownloadTask.OssStorageTypeInvalid Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.
    200 Forbidden.InstanceNotFound instance not found
    403 Request.Forbidden Have no Permissions
    403 DBS.NoPermissionException Rejected by ValidationChecker.
    404 DBS.NotExists data source do not existed.

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

    変更履歴

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