複数の画像を 1 つの PDF ファイルに変換し、指定された OSS オブジェクトとして保存します。
操作説明
この API を使用する前に、Intelligent Media Management の課金方法と料金を必ずご確認ください。
この API を呼び出す前に、現在のリージョンにアクティブなプロジェクトが存在することを確認してください。 詳細については、「プロジェクト管理」をご参照ください。
この API は最大 100 枚の入力画像をサポートします。
これは非同期 API です。 タスクが開始されると、その情報は 7 日間のみ保存され、この期間を過ぎると取得できなくなります。 タスク情報を表示するには、返された
TaskIdを使用して GetTask または ListTasks API を呼び出します。 Notification パラメーターを設定することで、非同期通知メッセージを介してタスク情報を受信することもできます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
imm:CreateImageToPDFTask |
create |
*Project
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ProjectName |
string |
必須 |
プロジェクトの名前。 詳細については、「プロジェクトの作成」をご参照ください。 |
test-project |
| Sources |
array<object> |
必須 |
入力画像のリスト。 画像は、このリスト内の URI の順序で変換されます。 |
|
|
object |
任意 |
入力画像に関する情報。 |
||
| URI |
string |
必須 |
ソース画像の OSS アドレス。 アドレスは `oss://${Bucket}/${Object}` 形式である必要があります。 ` サポートされているフォーマット:JPG、JP2、PNG、TIFF、WebP、BMP、SVG。 |
oss://examplebucket/sampleobject.jpg |
| Rotate |
integer |
任意 |
画像の回転角度 (度単位)。 有効な値:
|
90 |
| TargetURI |
string |
必須 |
出力 PDF ファイルが保存される OSS アドレス。 アドレスは `oss://${bucketname}/${objectname}` 形式である必要があります。 `${bucketname}` は、プロジェクトと同じリージョンにある OSS バケットである必要があります。 `${objectname}` は、ファイル名を含むファイルのパスである必要があります。 |
oss://examplebucket/outputDocument.pdf |
| UserData |
string |
任意 |
非同期通知メッセージで返されるカスタムユーザー情報。 これにより、通知メッセージをシステムに関連付けることができます。 最大長は 2048 バイトです。 |
test-data |
| CredentialConfig | CredentialConfig |
任意 |
特別な要件がない場合は、このパラメーターを空のままにしてください。 チェーン化された権限付与の構成。 詳細については、「チェーン化された権限付与を使用して他のエンティティのリソースにアクセスする」をご参照ください。 |
|
| Tags |
object |
任意 |
非同期タスクの検索とフィルターに使用されるカスタムタグ。 |
{ "User": "Jane" } |
| Notification | Notification |
任意 |
メッセージ通知の構成。 詳細については、Notification をクリックしてください。 非同期通知メッセージのフォーマットについては、「非同期通知メッセージのフォーマット」をご参照ください。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエスト ID。 |
EC564A9A-BA5C-4499-A087-D9B9E76E***** |
| EventId |
string |
イベント ID。 |
0ED-1Bz8z71k5TtsUejT4UJ16Es***** |
| TaskId |
string |
タスク ID。 |
ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d***** |
例
成功レスポンス
JSONJSON
{
"RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
"TaskId": "ImageToPDF-cbe6ae3e-f8dc-4566-9da7-535d5d*****"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。