すべてのプロダクト
Search

このプロダクト

    :CreateDownload

    ドキュメントセンター

    :CreateDownload

    最終更新日:Mar 20, 2026

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

    操作説明

    対応エンジン

    • RDS MySQL（クラウドディスクインスタンス）

    • RDS PostgreSQL

    • PolarDB for MySQL

    • ApsaraDB for 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 です。ApsaraDB RDS インスタンスの場合は DescribeDBInstanceAttribute 操作、PolarDB クラスターの場合は DescribeDBClusterAttribute 操作を呼び出して、リージョン ID を照会できます。

    cn-beijing
    InstanceName

    string

    必須

    インスタンス ID です。

    rm-wz994c1t1****
    BakSetType

    string

    任意

    ダウンロードタスクのタイプです。有効な値は以下のとおりです。

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

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

    full
    BakSetId

    string

    任意

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

    説明

    BakSetType を full に設定した場合、このパラメーターは必須です。

    146005****
    DownloadPointInTime

    string

    任意

    ダウンロード対象の時点を指定します。ミリ秒単位の UNIX タイムスタンプで指定してください。

    説明

    BakSetType を pitr に設定した場合、このパラメーターは必須です。

    1661331864000
    BakSetSize

    string

    任意

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

    216****
    FormatType

    string

    任意

    ダウンロードデータの出力フォーマットです。有効な値は以下のとおりです。

    • CSV

    • SQL

    • Parquet

    • Bson

    • qp.xb

    説明

    このパラメーターは必須です。Bson フォーマットは MongoDB インスタンスのみで使用可能です。qp.xb フォーマットは ApsaraDB RDS for MySQL インスタンスのみで使用可能です。

    列挙値:

    • qp.xb :

      qp.xb

    • csv :

      CSV

    • bson :

      Bson

    • csv-with-header :

      csv-with-header

    • parquet :

      Parquet

    • sql :

      SQL

    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

    任意

    ApsaraDB RDS for MySQL インスタンスから qp.xb フォーマットでデータをダウンロードする場合にのみ、このパラメーターが必要です。この場合、true を指定します。

    true

    レスポンスフィールド

    フィールド

    型

    説明

    例

    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
    200 DBS.DownloadTask.BakSetError DBS download task bak set error. Your backup set does not meet the requirements.
    200 DBS.DownloadTask.CustinIdNotSupport DBS DownloadTask CustinIdNotSupport.
    200 DBS.DownloadTask.CustinNameNotSupport DBS DownloadTask CustinNameNotSupport.
    200 DBS.DownloadTask.DbTypeNotSupport DBS DownloadTask DbTypeNotSupport.
    200 DBS.DownloadTask.InstanceInfoNotSupport DBS DownloadTask InstanceInfoNotSupport.
    200 DBS.DownloadTask.InstanceParamNotSupport DBS DownloadTask InstanceParamNotSupport.
    200 DBS.DownloadTask.InstanceStorageTypeNotSupport DBS DownloadTask InstanceStorageTypeNotSupport.
    200 DBS.DownloadTask.InstanceVersionNotSupport DBS DownloadTask InstanceVersionNotSupport.
    200 DBS.DownloadTask.NotSupport DBS DownloadTask NotSupport.
    200 DBS.DownloadTask.RegionNotSupport DBS DownloadTask RegionNotSupport.
    200 DBS.DownloadTask.UserNotSupport DBS DownloadTask UserNotSupport.
    403 Request.Forbidden Have no Permissions
    403 DBS.NoPermissionException Rejected by ValidationChecker.
    404 DBS.NotExists data source do not existed.

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

    変更履歴

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