すべてのプロダクト
Search
ドキュメントセンター

:CreateFileCompressionTask

最終更新日:Jan 27, 2026

パッケージダウンロード API

操作説明

説明

この API はパブリックプレビュー中です。ご不明な点がございましたら、DingTalk グループにご参加いただき、フィードバックをお寄せください。グループ番号については、「お問い合わせ」をご参照ください。

説明

この API は現在、パッケージングのみをサポートしており、圧縮はサポートしていません。圧縮機能は後日追加される予定です。

  • この API を使用する前に、Intelligent Media Management (IMM) の課金方法と料金を必ずご確認ください

    重要 非同期タスクの完了時間は保証されません。

  • ファイル数の上限:最大 80,000 個のファイルをパッケージングできます。

  • ファイルサイズの上限:パッケージング前のすべてのファイルの合計サイズは 200 GB を超えることはできません。

  • この機能は、OSS の標準ストレージクラスのファイルをサポートしています。他のストレージクラスのファイルをパッケージングするには、まずストレージクラスを変換してください。

  • これは非同期 API です。タスクが開始されると、その情報は 7 日間保存されます。7 日が経過すると、情報は取得できなくなります。タスク情報を表示するには、返された TaskId を使用して GetTask または ListTasks 操作を呼び出します。Notification パラメーターを設定して、非同期通知メッセージでタスク情報を受信することもできます。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

imm:CreateFileCompressionTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ProjectName

string

必須

プロジェクトの名前。詳細については、「プロジェクトの作成」をご参照ください。

test-project

Sources

array<object>

任意

パッケージングするファイルとそのパッケージングルールのリスト。

説明

このパラメーターまたは `SourceManifestURI` のいずれかを指定します。`Sources` は最大 100 個のパッケージングルールをサポートします。

警告 パッケージングルールが 100 個を超える場合は、`SourceManifestURI` パラメーターを使用してください。

object

任意

パッケージングするファイルの OSS アドレスとそのパッケージングルール。

URI

string

任意

パッケージングするディレクトリまたはファイルの OSS アドレス。

OSS アドレスは `oss://${Bucket}/${Object}` というフォーマットである必要があります。`${Bucket}` は、現在のプロジェクトと同じリージョンにある OSS バケットの名前です。`${Object}` は次のように説明されます:

  • ディレクトリをパッケージングする場合、`${Object}` はディレクトリ名です。

  • ファイルをパッケージングする場合、`${Object}` はファイル名拡張子を含むファイルの完全なパスです。

oss://test-bucket/test-object

Alias

string

任意

出力圧縮ファイル内でのソースファイルの新しいパスまたは名前を指定します。

  • このパラメーターを指定しない場合、ソースディレクトリ構造が保持されます。たとえば、ソースファイルが oss://test-bucket/test-dir/test-object.doc にある場合、圧縮ファイル内のファイルのパスは /test-dir/test-object.doc になります。

  • ファイルの名前を変更します。たとえば、ソースファイルが oss://test-bucket/test-object.jpg にあり、このパラメーターを /test-rename-object.jpg に設定した場合、圧縮ファイル内のファイル名は test-rename-object.jpg になります。

  • 圧縮ファイル内でソースファイルの新しいパスを指定します。たとえば、ソースディレクトリが oss://test-bucket/test-dir/ で、このパラメーターを /new-dir/ に設定した場合、ソースディレクトリ内のすべてのファイルは /new-dir/ パスに圧縮されます。

  • 値を / に設定すると、ソースディレクトリ構造が削除されます。すべてのファイルは圧縮ファイルのルートディレクトリに直接配置され、元のディレクトリ構造は保持されません。

  • パスとファイル名の両方を指定します。ファイルは名前が変更され、指定されたパスに移動します。たとえば、このパラメーターを /new-dir/alias.doc に設定すると、ファイルは alias.doc に名前が変更され、圧縮ファイルの /new-dir/ パスに配置されます。

説明
  • 名前の変更プロセス中に、重複する名前のファイルを作成しないようにしてください。重複する名前が存在する場合、使用する解凍プログラムによっては、圧縮パッケージ内のファイルを解凍できない場合があります。

  • フォーマット要件:値はスラッシュ (`/`) で始まる必要があります。例:/new-dir/alias.doc

/new-dir/

Mode

string

任意

パッケージングルールのパターンマッチングモード。有効な値には prefix (プレフィックスマッチング) と fullname (完全一致) があります。デフォルト値は prefix です。

  • prefix:このモードでは、プレフィックスに一致するすべてのファイルがパッケージングされます。

  • fullname:このモードでは、ルールに完全に一致するファイルのみがパッケージングされます。

列挙値:

  • prefix :

    prefix

  • fullname :

    fullname

fullname

CredentialConfig CredentialConfig

任意

特別な要件がない場合は、このパラメーターを空のままにしてください。

チェーンドオーソライゼーションの構成。このパラメーターは必須ではありません。詳細については、「チェーンドオーソライゼーションを使用して他のエンティティのリソースにアクセスする」をご参照ください。

SourceManifestURI

string

任意

マニフェストファイルが保存されているアドレス。マニフェストファイルは、`Sources` 構造を JSON フォーマットで OSS に保存します。これは、パッケージングするファイルが多いシナリオに適しています。

説明

このパラメーターまたは Sources のいずれかを指定します。マニフェストファイルでは、URI パラメーターは必須で、Alias パラメーターはオプションです。`SourceManifestURI` は最大 80,000 個のパッケージングルールをサポートします。

警告 コンテンツを OSS に保存する場合、このパラメーターにはファイルの OSS アドレスを指定します。

ファイル構造の例を次に示します:

[{"URI":"oss://<bucket>/<object>", "Alias":"/new-dir/new-name"}]

oss://test-bucket/test-object.json

TargetURI

string

必須

出力ファイルの OSS アドレス。圧縮ファイルは、このパスのファイル名 (例:name.zip) にちなんで命名されます。

OSS アドレスは `oss://${Bucket}/${Object}` というフォーマットである必要があります。`${Bucket}` は、現在のプロジェクトと同じリージョンにある OSS バケットの名前です。`${Object}` は、ファイル名拡張子を含むファイルの完全なパスです。

oss://test-bucket/test-target-object.zip

CompressedFormat

string

任意

ファイルパッケージングの圧縮フォーマット。

説明

現在、zip フォーマットのみがサポートされています。

zip

UserData

string

任意

カスタムユーザーデータ。このデータは非同期通知メッセージで返され、通知を内部システムに関連付けるのに役立ちます。最大長は 2,048 バイトです。

test-data

Notification Notification

任意

メッセージ通知設定。詳細については、Notification データ型をご参照ください。非同期通知メッセージのフォーマットについては、「非同期通知メッセージフォーマット」をご参照ください。

説明

IMM API のコールバックは現在、Webhook アドレスの指定をサポートしていません。代わりに MNS を使用してください。

典型的なシナリオにおけるパッケージングルールの例

以下の例は、サンプルファイル構造に基づいて、典型的なシナリオでパッケージングルールを構成する方法を示しています:

(bucket)
├── test-dir1
│   ├── file1.txt
│   ├── file2.doc
│   ├── file3.png
│   └── my-file.json
└── test-dir2
    ├── AAA
    │   └── file.txt
    ├── AAA
    ├── file6.doc
    ├── file7.doc
    └── file8.doc
指定されたディレクトリのパッケージング

test-dir1 ディレクトリ内のすべてのファイルを test-dir という名前の指定されたディレクトリにパッケージングするには、次のパッケージングルールを使用します:

[
    {
        "URI"   : "oss://bucket/test-dir1/",
        "Alias" : "/test-dir/"
    }
]

生成された圧縮ファイルの構造は次のとおりです:

.
└── test-dir
    ├── file1.txt
    ├── file2.doc
    ├── file3.png
    └── my-file.json
指定されたプレフィックスを持つファイルのパッケージング

プレフィックスが test-dir1/file のすべてのファイルを test-dir という名前の指定されたディレクトリにパッケージングするには、次のパッケージングルールを使用します:

[
    {
        "URI"   : "oss://bucket/test-dir1/file",
        "Alias" : "/test-dir/"
    }
]

生成された圧縮ファイルの構造は次のとおりです:

.
└── test-dir
    ├── file1.txt
    ├── file2.doc
    └── file3.png

プレフィックスモードを使用してパッケージングする場合、プレフィックスがファイルとフォルダの両方に一致すると、ファイルとフォルダの両方が圧縮ファイルにパッケージングされることに注意してください。例:

[
    {
        "URI"   : "oss://bucket/test-dir2/AAA",
        "Alias" : "/AAA/"
    }
]

生成された圧縮ファイルの構造は次のとおりです:

.
└── AAA
    ├── AAA
    └── file.txt
指定されたファイルのパッケージング

プレフィックスモードを使用したくない場合は、`mode` パラメーターを設定して、指定されたファイルのみをパッケージングします:

[
    {
        "URI"   : "oss://bucket/test-dir2/AAA",
        "Alias" : "AAA",
        "mode"  : "fullname",
    },
    {
        "URI"   : "oss://bucket/test-dir1/",
        "Alias" : "/test-dir1/",
        "mode"  : "fullname",
    }
]

生成された圧縮ファイルの構造は次のとおりです:

.
├── AAA
└── test-dir1

レスポンスフィールド

フィールド

説明

object

レスポンス構造体。

RequestId

string

リクエスト ID。

EC564A9A-BA5C-4499-A087-D9B9E76E*****

EventId

string

イベント ID。

0ED-1Bz8z71k5TtsUejT4UJ16Es*****

TaskId

string

タスク ID。

FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****

成功レスポンス

JSONJSON

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "FileCompression-3579a380-6f7a-4a9d-b9d2-65996*****"
}

エラーコード

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

変更履歴

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