コンテンツ・キャッシュのリフレッシュ
/sites/management/api/v1/sites/{id}/refresh
Google、Bing、Facebookなどのwebクローラおよび検索ボットのコンテンツ・キャッシュをリフレッシュします。キャッシュの内容は、通常、サイトのクロール時に提供されます。 キャッシュ・リフレッシュは、通常は毎時自動的に実行され、この操作により、その自動定期リフレッシュをプリエンプションできます。
リリース20.2.2で導入されました。
認可
この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:
- 所有者
- マネージャ
サイト・コンテンツ・キャッシュの更新
リフレッシュを使用すると、事前レンダリングされたサイト・コンテンツをより高速に使用できるようになります。 サイトが更新された場合でも、失効したサイト・コンテンツは自動リフレッシュが発生するまで配信できます。 これをすぐに実行する必要がある場合は、リフレッシュをリクエストする必要があります。 新しく公開されたサイト・コンテンツが使用可能な場合は、リフレッシュをトリガーしてそのコンテンツをサイトに組み込むことができます。
障害からのリカバリ
障害により、自動定期レンダラ・キャッシュ・リフレッシュの完了が妨げられている場合は、サイトを再公開するかわりにキャッシュをリフレッシュできます。
サイトのリフレッシュ・ジョブのモニター
新しいサイト・リフレッシュ・ジョブを作成するリクエストが受け入れられたら、レスポンスLocation
ヘッダーに指定されているジョブ・ステータス・リソースを読み取ることで、サイト・リフレッシュの進行状況を監視できます。
詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
リフレッシュ中のリスト・ページ
サイト・リフレッシュ・ジョブのステータスのモニタリングに加えて、ジョブ内のすべてのページとそのリフレッシュ・ステータスの詳細を読み取ることができます。
詳細は、「サイト・リフレッシュ・ジョブのリスト・ページ」を参照してください。
サイト・キャッシュ情報
サイト・キャッシュが最後に正常にリフレッシュされた時間を確認するには、サイトのキャッシュ・リソースを読み取ります。
詳細は、「サイト・キャッシュ情報」を参照してください。
非同期処理
この操作「のみ」非同期処理をサポートしています。 respond-async
の値を持つPrefer
ヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocation
ヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。
ステータスの読取りの詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
パス代替識別子
「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。
nameサイト名
サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。
http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/refresh
リリース19.4.1.での導入。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
202Accepted - Refresh Content Cache Job Started
新しいサイト・リフレッシュ・ジョブを作成するリクエストが受け入れられたら、レスポンスLocation
ヘッダーに指定されているジョブ・ステータス・リソースを読み取ることで、サイト・リフレッシュの進行状況を監視できます。
クライアント・エラー・レスポンスの例
この操作は次のクライアント・エラー(4xx)レスポンスで応答しますが、レスポンス本文に例外の詳細が示されるか、非同期ジョブを通じてレポートされます。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
403Forbidden - Site Operation Forbidden
サイト内で共有ロールを持つユーザーは、この操作を実行できません。
エラー・コード
OCE-SITEMGMT-009026
解決 - 共有ロールの変更
認証ユーザーに付与された共有ロールを必要なロール以上に変更します。
解決 - アプリケーション・ロールの変更
ユーザーにStandardユーザーまたはエンタープライズ・ユーザー・アプリケーション・ロールがあることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteOperationForbiddenExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Operation Forbidden", "status": "403", "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.", "o:errorCode": "OCE-SITEMGMT-009026", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
リリース19.1.5.での導入。
404Not Found - Site Not Found
サイトが存在しないか、削除されたか、認証されたユーザーまたはクライアント・アプリケーションがサイトへのアクセス権を持っていません。
エラー・コード
OCE-SITEMGMT-009003
解決 - 識別子のチェック
サイト識別子が有効であることを確認してください。
解決 - メンバーシップのチェック
認証済ユーザーがサイトのメンバーまたはサイト管理者であることを確認します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 存在しないか、認証されたユーザーが参照できないサイトです。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteNotFoundExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Not Found", "status": "404", "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.", "o:errorCode": "OCE-SITEMGMT-009003", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
409Conflict - Site Deleted
ソフト削除されたサイトでは操作を実行できません。 このエラーは、includeDeleted
問合せパラメータがtrue
に設定されている場合にのみ発生します。
エラー・コード
OCE-SITEMGMT-009059
解決 - サイトのリストア
サイトをリストアしてから操作を再試行してください。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | サイト識別子が指定されている場合、ソフト削除されるサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteDeletedExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Deleted", "status": "409", "detail": "The operation cannot be performed as the site has been soft deleted.", "o:errorCode": "OCE-SITEMGMT-009059", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
リリース19.4.1.での導入。
409Conflict - Invalid Site Status
サイトが間違った状態にあるため、サイト操作を実行できません。 すでにオンラインになっているサイトをオンラインにしたり、オンラインサイトの名前を変更したりする例。
エラー・コード
OCE-SITEMGMT-009013
解決 - セキュリティ・レベルを更新する前にサイトをオフラインにします
サイトがオンラインである間は、サイトのセキュリティ・レベルをパブリックからセキュア・サイトに変更したり、またはその逆に変更したりすることはできません。 サイトにサインインが必要かどうかを変更するために、サイトをオフラインおよび非公開にする必要があるかどうか。
解決 - 名前変更前にサイトをオフラインにします
サイトの名前を変更するには、オフラインで未公開である必要があります。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
runtimeStatus | サイト 有効な値は次のとおりです。
|
requiredStatus | 必須サイト・ステータスです。 有効な値は次のとおりです。
|
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのInvalidSiteRuntimeStatusExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Invalid Site Status", "status": "409", "detail": "Operation cannot be performed on a site with status '{runtimeStatus}'.", "o:errorCode": "OCE-SITEMGMT-009013", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" }, "runtimeStatus": "offline", "requiredStatus": "offline" }
409Conflict - Site is not a Public Site
パブリック・サイトではないサイトでは操作を実行できません。
エラー・コード
OCE-SITEMGMT-009091
解決 - セキュリティ・アクセスの変更
everyone
へのサイト・セキュリティ・アクセスを変更します。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
例外詳細フィールド
このエラー・タイプでは、レスポンスに次のフィールド/値が含まれます:
フィールド名 | 説明 |
site | 操作が実行されているサイト。 |
この例外の詳細タイプの詳細は、swaggerドキュメントの定義セクションのSiteNotPublicExceptionDetailスキーマを参照してください。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site is not a Public Site", "status": "409", "detail": "Operation cannot be performed on a site that is not a public site.", "o:errorCode": "OCE-SITEMGMT-009091", "site": { "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" } }
リリース20.2.1で導入されました。
409Conflict - Prerenderer Disabled
事前レンダラ無効例外
エラー・コード
OCE-PRE-001001
解決 - 事前レンダラ・サービスの有効化
設定で事前レンダリング・サービスを有効にし、失敗したリクエストを再試行してください。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次と等しくない」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Prerenderer Disabled", "status": "409", "detail": "A request to refresh the site cache cannot be processed when the prerender service is disabled.", "o:errorCode": "OCE-PRE-001001" }
リクエスト
- id: string
サイトの不変の識別子。
- includeDeleted(optional): boolean
削除対象としてマークされているリソースでは、この問合せパラメータが
true
に設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。includeDeleted
問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。
- Prefer(optional): string
respond-async
ヘッダー値を使用してリクエストの非同期処理をリクエストします。
レスポンス
202レスポンス
400レスポンス
401レスポンス
403レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object SiteOperationForbiddenExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
操作が実行されているサイト。
リリース19.1.5.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Operation Forbidden",
"status":"403",
"detail":"You do have a sharing role in this site, but your role does not allow you to use this operation.",
"o:errorCode":"OCE-SITEMGMT-009026",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
404レスポンス
- Cache-Control: string
キャッシュ・メカニズムのディレクティブ。
- Content-Length: string
レスポンス本文のサイズ。
- Content-Type: string
レスポンスのコンテンツ・タイプ。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object SiteNotFoundExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
存在しないか、認証されたユーザーが参照できないサイトです。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Not Found",
"status":"404",
"detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
"o:errorCode":"OCE-SITEMGMT-009003",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- object SiteDeletedExceptionDetail-allOf[1]
object
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- detail(optional): string
この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で問題を説明しています。
- instance(optional): string(uri)
エラーに関する詳細を提供するリンクへのURI。
- o:errorCode(optional): string
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、
title
やdetail
などのフィールドを比較するのではなく、特定のエラーをチェックするために使用する必要があります。 - o:errorDetails(optional): array o:errorDetails
階層構造に複数のエラーがある場合もあります。
- o:errorPath(optional): string
エラーが発生した場所を示すXPathまたはJSONパス。
- status(optional): integer(int32)
エラーに対応するHTTPステータス・コード。
- title(optional): string
問題の短く、判読可能なサマリー。 タイトルは、特定のエラーをチェックする方法としては使用しないでください。そのためには
o:errorCode
を使用してください。 - type(optional): string(uri)
問題のタイプを識別する絶対URI。 このURIが参照解除されると、「推奨」は、HTMLページなどの問題の判読可能なサマリーを提供します。
object
- site(optional): string
サイト識別子が指定されている場合、ソフト削除されるサイト。
リリース19.4.1.での導入。
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Deleted",
"status":"409",
"detail":"The operation cannot be performed as the site has been soft deleted.",
"o:errorCode":"OCE-SITEMGMT-009059",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid Site Status",
"status":"409",
"detail":"Operation cannot be performed on a site with status '{runtimeStatus}'.",
"o:errorCode":"OCE-SITEMGMT-009013",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
},
"runtimeStatus":"offline",
"requiredStatus":"offline"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site is not a Public Site",
"status":"409",
"detail":"Operation cannot be performed on a site that is not a public site.",
"o:errorCode":"OCE-SITEMGMT-009091",
"site":{
"id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Prerenderer Disabled",
"status":"409",
"detail":"A request to refresh the site cache cannot be processed when the prerender service is disabled.",
"o:errorCode":"OCE-PRE-001001"
}