ドキュメントDynamic Media Image Production System API

cdnCacheInvalidation cdncacheinvalidation

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 開発者
  • 管理者

指定された URL のリストをDynamic Media CDN （コンテンツ配布ネットワーク）プロバイダーに転送して、HTTP 応答の既存のキャッシュを無効にします。

cdnCacheInvalidation：概要 section-4f70d2bc79d64288b961836ab17e9690

CDN キャッシュの無効化は、これらの URL のすべての HTTP リクエストを、この無効化リクエストが CDN ネットワークを介して処理された後、Dynamic Media ネットワーク上の現在の公開済みデータに対して強制的に再検証します。 Dynamic Media サービスの URL 構造に接続されておらず、会社の作成時に割り当てられたDynamic Mediaの会社ルート ID と直接一致する URL があると、リクエスト全体で API エラーが発生します。 CDN でサポートされていない無効な URL が無効と見なされた場合も、リクエスト全体で API エラーが発生します。

使用頻度：ルール

この機能の使用頻度を制御するルールは、Dynamic Mediaの CDN パートナーによって制御されます。 CDN には、ユーザーに対するサービスの最適なパフォーマンスを維持するために、これらの無効化の応答性を低下させる裁量が保持されます。 この機能の過剰使用をDynamic Mediaに通知された場合、Adobeは、会社ごとに、またはサービス全体で機能を無効にする必要があります。

確認メール

Dynamic Media CDN パートナーからの確認メールは、リストの作成者に、または最大 5 つの他のメールアドレスに送信できます。 メールで参照されている URL がクリアされたことを CDN ネットワーク全体に通知すると、API は確認を送信します。 提供される URL の数が、1 回の通知でDynamic Mediaが CDN パートナーに配信できる数を超える場合、cdnCacheInvalidation への 1 回の呼び出しで複数のメールを送信できます。 現在のところ、リクエストが 100 個の URL を超える場合ですが、CDN パートナーのリクエストに基づいて変更される可能性があります。

サポート開始済み

6.0

許可されているユーザータイプ section-0d7895e733d54fb68beb8d231a04e4c9

  • IpsAdmin
  • IpsCompanyAdmin

パラメーター section-bd1ed2b7419945d19a2ebd5668499f72

入力 （cdnCacheInvalidationParam）

Name
Type
必須
Description
companyHandle
xsd:string
はい
無効にする URL に接続されている会社へのハンドル。
urlArray
のタイプ：UrlArray
はい
CDN キャッシュから無効にする最大 1,000 個の URL のリスト。 すべての URL が、無効にするDynamic Mediaの会社ルート ID を含んでいる必要があります。

出力 （cdnCacheInvalidationReturn）

Name
Type
必須
Description
invalidationHandle
xsd:string
はい

パージリクエストを参照するハンドル。

cdnCacheInvalidation API で、キャッシュをほぼ即座に（約 5 秒）無効化できるようになりました。 そのため、一般に、無効化ステータスのポーリングは不要になりました。

estimatedSeconds
xsd:int
はい
消去要求の完了までの推定秒数です。 クライアントは、ポーリング状態の前にこの時間を待機する必要があります。

例 section-f414361a58e84dfcbbac30a358d02125

この例では、CDN キャッシュ内で無効にする 4 つの URL をリクエストします。 応答には、操作の成功の概要カウントと、クライアントがこの機能を使用するのを支援するために CDN から直接提供されるエラーの詳細のリストが含まれています。

getCdnCacheInvalidationStatus 操作。

リクエスト

<cdnCacheInvalidationParam xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
   <companyHandle>c|6</companyHandle>
   <urlArray>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$thumbnail$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$product$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/11008047?$large$</items>
       <items>http://s7d7.scene7.com/is/image/JJEsquire/ImageSetConfigDefaults?req=userdata</items>
    </urlArray>
</cdnCacheInvalidationParam>

応答

<cdnCacheInvalidationReturn xmlns="http://www.scene7.com/IpsApi/xsd/2012-02-14">
   <successCount>4</successCount>
   <warningCount>0</warningCount>
   <errorCount>0</errorCount>
</cdnCacheInvalidationReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681