機械翻訳について

移動先

• リクエスト
• レスポンス

サイト・キャッシュ・リフレッシュ・ステータス

get

/sites/management/api/v1/sites/{id}/cache/status

RELATION

サイトの最新のレンダリング前キャッシュ・リフレッシュ・ジョブのステータス。 このジョブはまだ進行中であるか、失敗した可能性があります。 サイトは、定期的なシステム・リフレッシュによって自動的にリフレッシュされたか、APIを使用してリフレッシュされた可能性があります。

リリース20.2.2で導入されました。

認可

この操作を起動するには、認証されたユーザーまたはクライアント・アプリケーションがリソースと共有され、次のいずれかの「共有」ロールを持っている必要があります:

• 所有者
• マネージャ
• 貢献者
• ダウンロード実行者
• ビューア

サイト・コンテンツのリフレッシュ

最後のリフレッシュに最近のサイト更新が含まれていない場合は、サイト・コンテンツを強制的にリフレッシュできます。

詳細は、「コンテンツ・キャッシュのリフレッシュ」を参照してください。

サイト・キャッシュ情報

最新のリフレッシュ・ジョブが失敗したか、まだ実行中である可能性があります。 サイト・キャッシュが最後に正常にリフレッシュされた時間を確認するには、サイトのキャッシュ・リソースを読み取ります。

詳細は、「サイト・キャッシュ情報」を参照してください。

パス代替識別子

「サイト」リソースのデフォルトの識別子は、「サイト識別子」です。 サイト・リソースは代替識別子をサポートしています。

nameサイト名

サイト識別子のかわりに、サイト名を使用してリソース・パスのサイトを一意に識別できます。 サイトのデフォルトのリソース・パス・パラメータはサイト識別子ですが、サイトでの作業時には判読可能なサイト名が簡単になる場合があります。

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/cache/status

リリース19.4.1.での導入。

成功したレスポンスの例

この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

204No Content - Site Content Never Pre-Rendered

サイト・コンテンツは事前レンダリングされていません。

リダイレクション・レスポンスの例

この操作は、次のリダイレクション(3xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。 ノート: この操作の起動に使用されるクライアント・テクノロジによっては、リダイレクトが自動的に実行される場合に2xxレスポンスが返されることがあります。

303See Other - Refresh Site Content Job

現在または最新のサイト・リフレッシュに関する情報。

クライアント・エラー・レスポンスの例

この操作は、レスポンス本文に例外の詳細が含まれている次のクライアント・エラー(4xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。

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"
  }
}

このリソースは、サイトとリフレッシュ・サイト・ジョブ・ステータス・リソース間の関係を表します。 サイトに関連付けられたサイトのリフレッシュ・ジョブ・ステータスがない場合、レスポンス・ステータス・コードは204 No Contentになります。

リクエスト

パス・パラメータ

• id: string

  サイトの不変の識別子。

問合せパラメータ

• excludeFields(optional): string

  レスポンスに含めないフィールド名のカンマ区切り文字列。

• excludeLinks(optional): string

  レスポンスからexcludeへのリンク関係名のカンマ区切りリスト。

• expand(optional): string

  展開するフィールド名のカンマ区切りの文字列。 値allを使用して、すべての関係を展開します。

• expansionErrors(optional): string

  拡張のエラーの処理方法を指定します。 指定しない場合は、デフォルトで関連フィールドにエラーの詳細が含まれます。

  有効な値は次のとおりです。

  • ignore - エラーを無視して関係を展開しません。 関連リンクはレスポンスに含まれません
  • include - 展開された関係のかわりにエラー詳細を含めます。 関連リンクが返されます
  • fail - リクエストの拡張の失敗エラー・レスポンスでの失敗

• fields(optional): string

  レスポンスに含めるフィールド名のカンマ区切りの文字列。 フィールド名を区切るには、ドットを使用してネストされたフィールドを特定できます。 フィールド名は大文字と小文字を区別します。 フィールドが存在しない場合、フィールド名は無視されます。

• includeDeleted(optional): boolean

  削除対象としてマークされているリソースでは、この問合せパラメータがtrueに設定されているかぎり、読取り、変更およびサポート対象の拡張操作が可能です。 includeDeleted問合せパラメータを送信しない場合、読取り、変更および拡張操作に対するレスポンスは、リソースが完全に削除された場合に戻されるものと同じです。

• links(optional): string

  レスポンス内のincludeへのリンク関係名のカンマ区切りリスト。 デフォルトでは、すべてのリンクが返されます。

• return(optional): string

  レスポンス・フィールドおよびリンクの制御に使用するリソース表現を指定します。 表現が指定されない場合、fields、excludeFields、links、excludeLinksおよびexpand問合せパラメータの値に基づいて、クライアント定義の表現が戻されます。

  次の表現は、return問合せパラメータでサポートされています:

  表現	説明
  representation	フル・リソース表示には、すべてのプロパティとリンクが含まれ、大部分の関係が拡張されます。
  default	デフォルトのリソース表示には、ほとんどのプロパティとリンクが含まれます。
  basic	基本的なリソース表現には、いくつかのプロパティといくつかのリンクが含まれます。
  minimal	最小リソース表現。必須プロパティとリンクなしが含まれます。

トップに戻る

レスポンス

204レスポンス

内容なし

303レスポンス

他を参照

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止

404レスポンス

見つかりません

ヘッダー

• Cache-Control: string

  キャッシュ・メカニズムのディレクティブ。

• Content-Length: string

  レスポンス本文のサイズ。

• Content-Type: string

  レスポンスのコンテンツ・タイプ。

本文()

ルート・スキーマ: schema

すべてに一致

ソースを表示

• allOf SiteNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteNotFoundExceptionDetail"
        }
    ]
}

ネストされたスキーマ : SiteNotFoundExceptionDetail

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

• object SiteNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : ExceptionDetail

型: 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ページなどの問題の判読可能なサマリーを提供します。

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ : SiteNotFoundExceptionDetail-allOf[1]

型: object

ソースを表示

• site(optional): string

  存在しないか、認証されたユーザーが参照できないサイトです。

{
    "properties":{
        "site":{
            "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

ソースを表示

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

ネストされたスキーマ: items

すべてに一致

ソースを表示

• object ExceptionDetail

  HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

レスポンスの例(サイトが見つかりません)

{
    "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"
    }
}

429 レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

501レスポンス

実装されていない

502 レスポンス

ゲートウェイが不良

503レスポンス

サービス使用不可

504レスポンス

ゲートウェイがタイムアウト

先頭に戻る