PushObjectCache API を呼び出して、配信元サイトから L2 キャッシュノードへコンテンツをプリロードできます。 ユーザーが初回アクセス時にキャッシュを直接取得するようになるため、配信元サイトの負荷が軽減されます。
Alibaba Cloud CDN は、パラメーターがフォームとして送信される POST リクエストをサポートしています。
注
- RefreshObjectCaches API を呼び出してコンテンツを更新し、 PushObjectCache API を呼び出してコンテンツをプリロードできます。
- 同じ ID を使用して、毎日最大 2,000 個の URL からコンテンツをプリロードできます。
- リクエストごとに、最大 100 個の URL からコンテンツをアップロードできます。
- 毎秒最大 50 件のリクエストを送信できます。
デバッグ
Alibaba Cloud は、API の使用を簡素化するためにOpenAPI Explorerを提供しています。 OpenAPI Explorer を使用して、API の検索、API の呼び出し、SDK サンプルコードの動的生成を行うことができます。
リクエストパラメーター
| パラメータ | タイプ | 必須/省略可能 | 説明 |
|---|---|---|---|
| Action | String | はい | 実行する操作 (PushObjectCache) を設定します。 |
| ObjectPath | String | 必須 | コンテンツのプリロード元オブジェクトの URL を設定します (例：example.com/image/1.png )。 複数のURLを指定する場合は、改行 (\n ) または (\r\n) で区切ります。
|
| Area | String | いいえ | L2 キャッシュノードのリージョンを設定します。 設定可能な値は次のとおりです。
|
応答パラメーター
| Parameter | データ型 | 説明 |
|---|---|---|
| PushTaskId | String | 返されたプリロードタスクの ID を示します。 複数のタスクが返される場合、ID はコンマ (,) で区切られます。 |
例
リクエスト例
https://cdn.aliyuncs.com?&Action=PushObjectCache&ObjectPath=example.com/test.txt&ObjectType=File&<Common request parameters> 正常に処理された場合のレスポンス例
JSON 形式
{
"PushTaskId": "95248880",
"RequestId": "E5BD4B50-7A02-493A-AE0B-97B9024B4135"
}XML format
<PushObjectCacheResponse>
<PushTaskId>95250421</PushTaskId>
<RequestId>5FF9B16E-FBAC-48E5-9052-65B5F0184DB3</RequestId>
</PushObjectCacheResponse>エラーコード
| エラーコード | エラーメッセージ | HTTP ステータスコード | 説明 |
|---|---|---|---|
| Throttling | Request was denied due to request throttling. | 503 | 帯域幅調整が行われ、リクエストが拒否された場合に返されるエラーメッセージです。 |
| IllegalOperation | Illegal domain operate is not permitted. | 403 | 指定されたドメイン名が正しくない場合に返されるエラーメッセージです。 |
| OperationDenied | Your account does not open CDN service yet. | 403 | ご利用中のアカウントで CDN の利用を開始していない場合に返されるエラーメッセージです。 CDN の利用を開始する方法については、「購入手順」をご参照ください。 |
| OperationDenied | Your CDN service is suspended. | 403 | ご利用中のアカウントで CDN が一時停止された場合に返されるエラーメッセージです。 |
| InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 指定された CDN ドメインが存在しないか、自分のものではない場合に返されるエラーメッセージです。 |
| InvalidDomain.Offline | 指定されたドメインはオフラインです。 | 404 | 指定された CDN ドメインが無効化されている場合に表示されるエラーメッセージです。 |
| QuotaExceeded.Refresh | You've exceeded the prescribed refresh limits. | 400 | 1 日に処理できる更新オブジェクトの上限を超えた場合に返されるエラーメッセージです。 |
| PreloadQueueFull | Preload queue is full, please try again later! | 403 | プリロードされている URL の数が上限に達している場合に返されるエラーメッセージです。 しばらくしてから再試行します。 |
| InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | システムがドメインの設定に失敗し、コンテンツを更新できなかった場合に返されるエラーメッセージです。 |
| MissingParameter | The input parameter "ObjectPath" that is mandatory for processing this request is not supplied. | 400 | ObjectPath パラメーターが設定されていない場合に返されるエラーメッセージです。 |
| InvalidObjectPath.Malformed | The specific value of parameter ObjectPath is malformed. | 400 | 設定された ObjectPath パラメーターが正しくない場合に返されるエラーメッセージです。 |
| InvalidExtensiveDomain.ValueNotSupported | Extensive domain not supported. | 400 | ワイルドカードドメインがサポートされていないために返されるエラーメッセージです。 |
| InvalidObjectPath.Size.Malformed | The size of ObjectPath is bigger than 100. | 400 | 一度にプリロードする URL が 100 を超えている場合に返されるエラーメッセージです。 |