CreateArchiveFileInspectionTask - - Alibaba Cloud ドキュメントセンター

操作説明

説明

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

この API を使用する前に、Intelligent Media Management (IMM) の課金方法と料金を必ずご確認ください。
重要非同期タスクの完了時間は保証されません。
ファイル数の上限：圧縮ファイルには最大 80,000 個のファイルを含めることができます。
ファイルサイズの制限：最大サイズは、ZIP および RAR ファイルの場合は 200 GB、7z ファイルの場合は 50 GB です。
これは非同期 API です。タスク情報はタスク開始後 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:CreateArchiveFileInspectionTask

create

*Project

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectName	string	必須	プロジェクト名。詳細については、「プロジェクトの作成」をご参照ください。	test-project
CredentialConfig	CredentialConfig	任意	特別な要件がない場合は、このパラメーターを空のままにしてください。チェーン権限付与の構成。このパラメーターは必須ではありません。詳細については、「チェーン権限付与を使用して他のエンティティのリソースにアクセスする」をご参照ください。
Password	string	任意	圧縮ファイルのパスワード。ファイルが暗号化されている場合は、パスワードを指定して内容を検査します。	123456
UserData	string	任意	非同期の通知メッセージで返されるカスタム情報。この情報を使用して、通知メッセージをサービスに関連付けることができます。最大長は 2,048 バイトです。	test-data
SourceURI	string	任意	圧縮ファイルの場所。 Object Storage Service (OSS) URI は oss://${Bucket}/${Object} というフォーマットである必要があります。このフォーマットでは、`${Bucket}` は現在のプロジェクトと同じリージョンにある OSS バケットの名前で、`${Object}` はファイル名拡張子を含むファイルの完全なパスです。	oss://bucket/test-object.zip
Notification	Notification	任意	通知設定。詳細については、「Notification」をご参照ください。非同期通知メッセージのフォーマットについては、「非同期通知メッセージのフォーマット」をご参照ください。説明現在、IMM の API コールバックはカスタム Webhook アドレスをサポートしていません。代わりに MNS を使用してください。

圧縮ファイル内のファイルリストを取得するには、Notification の ExtendedMessageURI パラメーターを設定します。生成されるファイルリストは次のように構成されます：

{
  "Password" : "圧縮ファイルのパスワード",
  "IsEncryption": "true/false、圧縮ファイルが暗号化されているかどうかを指定します",
  "ArchiveFiles": [
    {
      "PathName": "圧縮ファイルからの相対パス。例：./test-dir/test.txt",
      "Reason": "検査が失敗した場合の失敗理由。",
      "IsFolder": "true/false、エントリがフォルダであるかどうかを指定します",
      "PackedSize": "圧縮ファイル内でのファイルのサイズ",
      "UnPackedSize": "展開後のファイルのサイズ",
      "FileAccessTime": "ファイルのアクセス時間。",
    },
    {
      "PathName": "./test-dir/",
      "Reason": "",
      "IsFolder": "true",
      "PackedSize": "0",
      "UnPackedSize": "0",
      "FileAccessTime": "2023-07-21T09:46:35Z",
    },
  ]
}

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
RequestId	string	リクエスト ID。	EC564A9A-BA5C-4499-A087-D9B9E76E*****
EventId	string	イベント ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es*****
TaskId	string	タスク ID。	ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****

例

成功レスポンス

JSONJSON

{
  "RequestId": "EC564A9A-BA5C-4499-A087-D9B9E76E*****",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es*****",
  "TaskId": "ArchiveFileInspection-8475218e-d86e-4c66-b3cf-50e74d6c****"
}

エラーコード

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

変更履歴

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