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

操作説明

リクエストメソッド: POST リクエストがサポートされています。パラメーターはフォームに表示されます。
関連操作: リフレッシュおよびプリフェッチ操作には、 RefreshObjectCaches リフレッシュ操作と PushObjectCache プリフェッチ操作が含まれます。
日次 URL プリフェッチクォータ: デフォルトでは、各アカウントは 1 日あたり最大 1,000 件の URL プリフェッチタスクを送信できます。アカウントの日次ピーク帯域幅が 200 Mbit/s を超える場合、チケットを送信して、より高い日次割当クォータをリクエストできます。Alibaba Cloud は実際のビジネス要件に基づいてクォータを評価し構成します。
一度に最大 100 件の URL プリフェッチタスクを送信できます。
プリフェッチキュールール: 各アカウントのプリフェッチキューサイズの最大値は 100,000 URL です。CDN は送信された順序で URL をプリフェッチします。キュー内のプリフェッチ待ちの URL 数が 100,000 に達すると、CDN は新しいプリフェッチタスクを拒否します。
各ユーザーがこの操作を 1 秒あたりに呼び出しできる最大値の回数: 50。
リフレッシュまたはプリフェッチタスクを自動化するには、リフレッシュおよびプリフェッチ用スクリプトを参照してください。

事前準備

プリフェッチタスクが送信され正常に実行されると、ポイントオブプレゼンスは直ちに back-to-origin フェッチを実行して必要なリソースをロードします。大量のプリフェッチタスクを送信すると、多数の同時ダウンロードタスクが生成され、back-to-origin 帯域幅とリクエストが急増し、オリジンサーバーのロードが増加します。
プリフェッチタスクの送信から完了までの実際の実行時間は、プリフェッチされるファイルのサイズに依存し、通常 5〜30 分かかります。平均ファイルサイズが小さいほど、プリフェッチは速くなります。
Resource Access Management (RAM) ユーザーを使用してリフレッシュまたはプリフェッチ操作を実行するには、まず必要な権限付与を取得してください。リフレッシュおよびプリフェッチの RAM ユーザーへの権限付与を参照して権限付与を完了してください。
プリフェッチリクエストで送信されるデフォルトヘッダーは Accept-Encoding:gzip です。プリフェッチリクエストで他のヘッダーを送信したり、マルチコピープリフェッチを実装したりするには、WithHeader リクエストパラメーターを使用してプリフェッチヘッダーをカスタマイズしてください。
プリフェッチ中にオリジンサーバーが 307 などの自動転送状態コードを返した場合、プリフェッチタスクはリダイレクト URL をフォローしてプリフェッチを完了しないため、プリフェッチが失敗します。オリジンサーバーが 301 または 302 状態コードを返し、CDN で 302 自動転送が有効になっている場合、通常のプリフェッチには影響しません。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cdn:PushObjectCache

none

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ObjectPath	string	必須	プリフェッチする URL。フォーマットは加速ドメイン名/プリフェッチするファイルです。説明複数の URL は改行で区切ってください。各 URL の最大長は 1,024 文字です。	example.com/image/1.png\nexample.org/image/2.png
Area	string	任意	プリフェッチリージョン。有効な値: domestic: 中国本土のみ。 overseas: グローバル（中国本土を除く）。このパラメーターを設定しない場合、デフォルトのプリフェッチリージョンはドメイン名に構成された CDN 加速リージョンです。説明プリフェッチリージョンをグローバルに設定するには、加速ドメイン名の加速リージョンがグローバルに設定されていることを確認し、このパラメーターを空のままにしてください。	domestic
L2Preload	boolean	任意	コンテンツを L2 ノードに直接プリフェッチするかどうかを指定します。有効な値: true: プリフェッチノードレベルに L2 ノードを含める必要があります。 false: back-to-origin レイヤーノードのみがプリフェッチされます。これがデフォルト値です。back-to-origin レイヤーノードは L2 または L3 ノードです。	true
WithHeader	string	任意	プリフェッチリクエストで送信されるデフォルトヘッダーは Accept-Encoding:gzip です。プリフェッチリクエストで他のヘッダーを送信したり、マルチコピープリフェッチを実装したりするには、このパラメーターを使用してプリフェッチヘッダーをカスタマイズしてください。値は JSON フォーマットで送信してください。説明プリフェッチ時に Accept-Encoding ヘッダーを除外するには、以下を送信してください: {"Accept-Encoding": [" "]}。	{ "Accept-Encoding": [ "gzip, deflate, br" ] }
QueryHashkey	boolean	任意	プリフェッチタスクの実行時にハッシュキークエリモードを有効にするかどうかを指定します。有効な値: false: デフォルトモード。このモードはパラメーターが指定されていない場合に使用されます。送信された URL がプリフェッチファイルのハッシュキーとして直接使用されます。 true: ドメイン名の構成に基づいてプリフェッチ URL で使用される実際のハッシュキーをクエリします。	true
ConsistencyHash	boolean	任意	ドメイン名の加速リージョンが中国本土で、ハッシュベースの back-to-origin フェッチが有効になっている場合、このパラメーターを使用してハッシュベースのプリフェッチを有効にできます。これにより、リージョン別の back-to-origin 収束が実装され、プリフェッチによって生成されるオリジン帯域幅が削減されます。 true: ハッシュベースのプリフェッチを有効にします。 false: デフォルトの動作。ハッシュベースのプリフェッチは有効になりません。重要このパラメーターは、加速リージョンが中国本土のドメイン名に対してのみ効果があります。。	true

レスポンスフィールド

フィールド	型	説明	例
	object
PushTaskId	string	プリフェッチタスクの ID。複数のタスク ID はカンマ (,) で区切られます。返されるタスク ID は以下のルールに基づいてマージされます: 同一秒内に同じドメイン名に対して送信されたプリフェッチタスク（URL 粒度）は、単一の PushTaskId にマージされます。同一秒内に同じドメイン名に対して 500 件を超えるプリフェッチタスク（URL 粒度）が送信された場合、500 件ごとのバッチで PushTaskId 値にマージされます。	9524xxxx
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

例

成功レスポンス

JSONJSON

{
  "PushTaskId": "9524xxxx",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	SingleRequest.OverLimit	A maximum of 1000 URLs are supported for each request.
400	QuotaExceeded.Preload	Your preload attempts have exceeded the daily limit.	The maximum number of URL prefetches on the current day is exceeded.
400	InvalidObjectPath.Malformed	The specified ObjectPath is invalid.
400	InvalidExtensiveDomain.ValueNotSupported	The specified ExtensiveDomain is not supported.
400	PreloadQueueFull	The warming queue is full,please try again later.
400	QuotaPerMinuteExceeded.Refresh	You have exceeded the prescribed preload limits per minute.
400	InvalidObjectPath.ExceedsMaximum	The maximum number of urls is exceeded.	The number of submitted URLs exceeds the maximum limit.
400	InvalidCustomHeader	Parse preload header failed.	Custom header parsing error.
429	TooManyRequests	System load fluctuates, please try again later.	System load fluctuates, please try again later.

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

変更履歴

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