キャンペーン・インスタンスまたはシリーズの終了
post
/access-governance/access-reviews/20250331/campaigns/{campaignId}/actions/terminate
進行中のキャンペーン・インスタンスまたはシリーズを終了します。
リクエスト
パス・パラメータ
- campaignId(required): string
一意のキャンペーン識別子。
問合せパラメータ
- type: string
退職タイプ。許容値:
[ "INSTANCE", "SERIES" ]
ヘッダー・パラメータ
- if-match: string
オプティミスティックな同時実行性制御用。 リソースのPUTまたはDELETEコールで、`if-match`パラメータを、そのリソースの以前のGETまたはPOSTレスポンスからのetagの値に設定します。 リソースは、指定したetagがリソースの現在のetag値と一致する場合にのみ更新または削除されます。
- opc-request-id: string
トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。
- opc-retry-token: string
最小長:
1
最大長:64
タイムアウトまたはサーバー・エラーの場合に、同じアクションを再度実行するリスクがなくても再試行できるように、リクエストを一意に識別するトークン。 再試行トークンは24時間後に失効しますが、操作が競合するために無効化することができます。 たとえば、リソースがシステムから削除およびパージされた場合、元の作成リクエストの再試行が拒否されることがあります。
レスポンス
サポートされているメディア・タイプ
- application/json
202レスポンス
キャンペーンを終了する作業リクエストが作成されました。
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
- opc-work-request-id: string
非同期リクエストに対するOracleで割り当てられた一意の識別子。 これを使用して、非同期操作のステータスを問い合せることができます。
400レスポンス
不正なリクエスト
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
401レスポンス
未認可
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
404レスポンス
見つかりません
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
409レスポンス
競合
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
412レスポンス
事前条件は失敗しました
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
429レスポンス
リクエストが多すぎます
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
500レスポンス
内部サーバー・エラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
デフォルト・レスポンス
不明なエラー
ヘッダー
- opc-request-id: string
リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。
ルート・スキーマ : Error
型:
object
エラー情報。
ソースを表示
- code(必須): string
プログラム解析用のエラーを定義する短いエラー・コード。
- message(必須): string
判読可能なエラー文字列。
例
次の例は、キャンペーンまたはキャンペーン・シリーズを終了する方法を示しています。 スケジュール済キャンペーンは、キャンペーンが承認されるか、システムが終了するまでいつでも終了できます
cURL例 - キャンペーンの終了
curl -i -L -X POST \
-H "Authorization:Bearer <your access token>" \
'${service-instance-url}/access-governance/access-reviews/${version}/campaigns/${campaignID}/actions/terminate'
RESTクライアント・ツールでのcURLコマンド
メソッドとしてPOSTを選択
${service-instance-url}/access-governance/access-reviews/${version}/campaigns/${campaignID}/actions/terminate
レスポンス本文の例
204 No Content