サイトの失効
/sites/management/api/v1/sites/_expire
サイトをオフラインにする、サイトが期限切れになった場合はサイトを削除するなど、サイト失効処理を実行します。 サイト・ガバナンスが有効で、サイトに有効期限が設定されている場合、サイトは、サービス定義済のサイト失効設定に基づいてオフラインまたは削除できます。 このメソッドを実行すると、この処理が実行され、サイトがまだ失効していない場合には何も実行されない可能性があります。サイトの期限が切れている場合はサイトをオフラインにし、サイトがオンラインの場合はサイトを削除するか、サイトが期限切れになってから「削除」期間が経過した場合はサイトを削除します。 このメソッドは、期限切れになっているすべてのサイトを調べます。
リリース20.3.2で導入されました。
認可
この操作を起動するには、認証されたユーザー・アプリケーションまたはクライアント・アプリケーションが次のいずれかのロールを持っている必要があります:
- CECSitesAdministrator
電子メール通知
Eメール通知は、期限が切れているサイトのライフサイクルの様々な時点でサイト・マネージャおよびサイト所有者に送信されます。 サイト管理者は、サイトを非アクティブ化または削除できない場合に電子メールも送信します。 サイトに50を超えるユーザー、アプリケーションまたはマネージャ・ロールを持つグループがある場合、最初の50人はEメールを受け取ります。 サイト失効処理が実行されると、電子メール通知が送信されます:
- サイトが30日以内に失効した場合
- サイトの期限が5日後
- サイトが1日以内に失効した場合
- サイトが期限切れになり、オフラインになった場合
- サイトが期限切れになり、オフラインにならない場合
- サイトが失効し、3日以内に削除予定である場合
- サイトが失効し、削除された場合
- サイトが期限切れであり、削除できない場合
サイト・ガバナンス
サイトの失効は、サイト・ガバナンスが有効になっている場合にのみ使用できます。 サイト・ガバナンスが無効になっている場合、サイト失効処理リクエストは拒否されます。
失効設定の変更
デフォルトでは、このメソッドではサービス定義のサイト有効期限設定が使用されます。 これらの設定は変更できます。
詳細は、「サイト管理設定の更新」を参照してください。
サイトの有効期限の延長
サイト所有者またはマネージャは、拡張操作を使用してサイトの失効日を拡張し、非アクティブ化または削除を停止できます。
詳細は、「サイトの有効期限の延長」を参照してください。
非同期処理
この操作「のみ」非同期処理をサポートしています。 respond-asyncの値を持つPreferヘッダーがリクエストに含まれている必要があります。 「承認済」レスポンスにはLocationヘッダーが含まれ、非同期処理に関する情報を取得するためにポーリングできる「ステータス・リソース」のロケーションを示します。 結果をポーリングする推奨間隔は1000ミリ秒です。 ポーリング間隔は、ステータス・リソース・レスポンスの読取り時にも返されます。 非同期リクエストが完了すると、ステータス情報は5000ミリ秒で使用できます。 この時間が経過すると、この非同期リクエストのステータスは「見つかりません」でレスポンスします。
Cookieヘッダーに、Set-Cookieレスポンス・ヘッダーが含まれていることを確認します。 ステータスの読取りの詳細は、「サイト関連ジョブの進捗の取得」を参照してください。
成功したレスポンスの例
この操作は、次の成功(2xx)のレスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
202Accepted - Site Expiration Processing Started
サイトの失効が非同期で実行されると、リクエストの進捗状況は、レスポンスLocationヘッダーで提供されるジョブ・ステータス・リソースを読み取ることで監視できます。
リダイレクション・レスポンスの例
この操作は、次のリダイレクション(3xx)レスポンスで応答します。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。 ノート: この操作の起動に使用されるクライアント・テクノロジによっては、リダイレクトが自動的に実行される場合に2xxレスポンスが返されることがあります。
303See Other - Expire Sites Using the Service Defaults
サービス定義設定を使用して、すべてのサイトのサイト失効処理を実行します。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/_expire
リクエスト・ヘッダー
Prefer=respond-async
303See Other - Deactivate expired Sites
サイトの有効期限処理を実行し、必要に応じてサイトを非アクティブ化します。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/_expire
リクエスト・ヘッダー
Prefer=respond-async
リクエスト本文
{ "action": "deactivate", "deleteAfter": 5 }
303他を参照 - 失効済サイトの削除
サイトを非アクティブ化するようにリクエストしているサイト失効処理を実行します。 サイトが3日以上前に失効した場合も、サイトが削除されます。
リクエスト
POST https://api.example.com/sites/management/api/v1/sites/_expire
リクエスト・ヘッダー
Prefer=respond-async
リクエスト本文
{ "action": "delete", "deleteAfter": 3 }
クライアント・エラー・レスポンスの例
この操作は次のクライアント・エラー(4xx)レスポンスで応答しますが、レスポンス本文に例外の詳細が示されるか、非同期ジョブを通じてレポートされます。 レスポンスHTTPステータス・コードとサンプル本体の完全なリストは、この操作の「レスポンス」に関する項を参照してください。
409Conflict - Site Governance Disabled
サイト・ガバナンスが有効または無効になるのは、サイト管理者が制御するテナント全体の設定です。 サイト・ガバナンスが無効になっている場合、サイトに対するリクエストの作成、サイトのアクティブ化など、サイト管理REST APIで特定のメソッドが禁止されます。
エラー・コード
OCE-SITEMGMT-009002
解決 - サイト・ガバナンスの有効化
「サイトとアセット」管理者設定を使用してサイトのガバナンスを有効にし、失敗したリクエストを再試行してください。
このエラーが返される場所
- このエラー「次の場合があります」がレスポンス本文に返されました。
- このエラー「次の場合があります」は非同期ジョブ・ステータスで返されました。
レスポンス本文の例
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Governance Disabled", "status": "409", "detail": "A request to create or copy a site cannot be processed when site governance is disabled.", "o:errorCode": "OCE-SITEMGMT-009002" }
リクエスト
- application/json
- Prefer(optional): string
respond-asyncヘッダー値を使用してリクエストの非同期処理をリクエストします。 - X-Suppress-Notifications(optional): boolean
リクエストごとに通知が送信されないようにするクライアントの場合、このヘッダーは値
trueに設定できます。 通知が通常送信される場合でも、このヘッダーによってリクエストの通知配信が抑制されます。
サイト失効上書き。 本文が指定されていない場合、デフォルトのサービス・ワイド・サイトの有効期限設定が使用されます。
objectサイト失効関連の設定(自動サイトの非アクティブ化および削除の有効化または無効化など)。 サイトの有効期限は、サイト・ガバナンスが有効になっている場合にのみ有効です。
リリース20.3.1で導入されました。- action(optional): string
サイトの期限が切れたときに実行するアクション。 これは何もできない可能性があります。 サイトがオンラインの場合、サイトはオンラインのままになります。 非アクティブ化アクションは、サイトの期限が切れた後にサイトをオフラインにします。 サイトの期限が切れてサイトも削除されると、削除アクションはサイトをオフラインにします。 サイトは、サイトが削除されるまでの失効後の期間を判断するために、翌日を使用して削除されます。
有効な値は次のとおりです。
-
nothing- サイトはオンラインのままなので削除されません -
deactivate- サイトは、サイトの期限が切れるとオフラインになります -
delete- サイトは、有効期限が切れた後に構成可能な日数後にサイトの期限が切れるとオフラインになります
-
- deleteAfter(optional): integer(int32)
最小値:
3最大値:90サイトを削除する前に、サイトが失効してから待機する日数。 この設定は、選択したアクションが期限切れサイトを削除する場合にのみ使用されます。 サイトの削除が無効になっている場合、この設定は引き続き設定できます。設定値は無視されます。
リリース20.3.1で導入されました。
レスポンス
202レスポンス
303レスポンス
400レスポンス
401レスポンス
403レスポンス
409レスポンス
- object ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
-
objectHTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
- 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 ExceptionDetail
HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 その場合、追加情報がレスポンス本文に含まれます。
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Governance Disabled",
"status":"409",
"detail":"A request to create or copy a site cannot be processed when site governance is disabled.",
"o:errorCode":"OCE-SITEMGMT-009002"
}