ジャンプ先

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

現在のポリシーからのポリシー・キャッシュの構築

post

/iam/admin/ssa/api/v1/policycacheadmin/policycache

OAMデータベースの現在のポリシーを使用してポリシー・キャッシュを構築します。ポリシー・キャッシュの構築中は、ランタイム・サーバーが既存のポリシー・キャッシュを引き続き使用します。

リクエスト

サポートされるメディア・タイプ

• application/json
• application/xml

本文()

ポリシー・キャッシュ・リクエスト

ルート・スキーマ: CacheUpdateRequest

タイプ: object

ソースの表示

• forceUpdate: boolean
  現在のバージョンが、構築された最新バージョンである場合でも、ポリシー・キャッシュを強制的に更新するかどうか。デフォルトでは、これはfalseであり、ポリシー・キャッシュは更新されません(ただし、最新でない場合を除きます)。

{
    "type":"object",
    "properties":{
        "forceUpdate":{
            "type":"boolean",
            "description":"Whether to forceupdate the policy cache even when current version is the latest version built. By default this is false and the policy cache will not be updated unless it is not the latest."
        }
    },
    "required":[
        "forceUpdate"
    ]
}

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json
• application/xml

200レスポンス

ポリシー・キャッシュ情報が正常にフェッチされました。

本文()

ルート・スキーマ: CacheUpdateResponse

タイプ: object

ソースの表示

• checkSum: string
  ポリシー・キャッシュのハッシュ値。2つのバージョンのポリシー・キャッシュのチェックに使用できます。
• message(optional): string
  この操作の戻りメッセージ。操作が失敗した場合、エラー・メッセージには、操作の実行中に発生した問題に関する必要な詳細情報が示されます。
• updatedBy: string
  policycacheを更新したユーザーの参照。強制更新される場合、RESTのユーザー名が使用されます。
• updatedOrCreated(optional): boolean
  このREST APIコールによって、既存のキャッシュ行が更新されるか、作成されるか。
• updateTime: string
  前回のキャッシュの作成が終了して表に書き込まれた日時。
• version: string
  このポリシー・キャッシュのバージョン番号。ランタイム・サーバーおよび管理サーバーの更新ロジックに使用されます。

{
    "type":"object",
    "properties":{
        "updatedBy":{
            "type":"string",
            "description":"Reference of user that updated the policycache. In case its forceupdated, the REST username is used."
        },
        "updateTime":{
            "type":"string",
            "description":"The date time when the cache was last finised creation and written into the table."
        },
        "updatedOrCreated":{
            "type":"boolean",
            "description":"Whether the existing cache row is updated due to this REST API call or created."
        },
        "checkSum":{
            "type":"string",
            "description":"The hash value of the policy cache. Can be used for checking two versions of the policy cache."
        },
        "version":{
            "type":"string",
            "description":"version number of this policy cache. Used for updation logic for runtime and admin servers."
        },
        "message":{
            "type":"string",
            "description":"The return message for this operation. If the operation failed, the error message has the required details on what went wrong while performing the operation."
        }
    },
    "required":[
        "updatedBy",
        "updateTime",
        "checkSum",
        "version"
    ]
}

401レスポンス

権限がありません。

500レスポンス

内部サーバー・エラー

先頭に戻る