REST APIリファレンス

前へ次へ

Secure AgentグループのSecure Agentサービスプロパティの設定

runtimeEnvironmentリソースを使用して、Secure AgentグループのSecure Agentサービスプロパティを設定できます。Secure AgentグループにSecure Agentを追加すると、エージェントはデフォルトで、Secure Agentサービスのデフォルト設定ではなく、グループレベルのプロパティ設定を使用します。

Secure Agentグループに対して設定できるSecure Agentサービスプロパティは、グループに割り当てられているサービスとコネクタによって異なります。特定のSecure Agentグループの編集可能なプロパティを表示するには、設定の詳細に対するGET要求を送信します。

Secure AgentグループのSecure Agentサービスプロパティを設定する場合は、次のようなルールが適用されます。

グループレベルのプロパティ設定を使用するように設定されたSecure AgentグループにSecure Agentを追加すると、エージェントのプロパティ設定がグループレベルのプロパティ設定に置き換えられます。エージェントにカスタムプロパティがある場合、カスタムプロパティは削除されます。

グループレベルのプロパティ設定を使用するように設定されたSecure Agentグループからグループレベルのプロパティ設定を使用しないグループにSecure Agentを移動すると、エージェントではグループレベルで設定されたプロパティ設定が保持されます。

グループレベルのプロパティ設定を使用するSecure Agentグループ内のエージェントに対して、エージェントレベルのSecure Agentサービスプロパティを設定しないでください。エージェントレベルのプロパティを設定する場合は、エージェントプロパティを設定する前に、グループレベルのプロパティ設定を削除します。

GET要求

Secure Agentグループで設定できる編集可能なSecure Agentサービスプロパティのリストを取得するには、GET要求を使用します。

また、Secure Agentサービスのデフォルトのプロパティ設定を上書きしたグループレベルのプロパティのリストを取得することもできます。

URIにSecure AgentグループのIDを含めます。必要に応じて、URIにプラットフォームを含めます。linux64またはwin64を使用できます。デフォルトのプラットフォームはlinux64です。

次のいずれかのURIを使用します。

編集可能なプロパティのリストを取得するには、次のURIを使用します。

/api/v2/runtimeEnvironment/<id>/configs/details/<platform>

Secure Agentサービスのデフォルトのプロパティ設定を上書きするグループレベルのプロパティのリストを取得するには、次のURIを使用します。

/api/v2/runtimeEnvironment/<id>/configs/<platform>

GET応答

成功時の応答は、Secure Agentサービス、プロパティタイプ、およびプロパティタイプのオブジェクトの次のフィールドを返します。

フィールド	タイプ	説明
name	String	プロパティ名。
value	String	Secure Agentグループに追加されたすべてのエージェントに使用される値。
isCustom	Boolean	プロパティがカスタムプロパティかどうかを示します。
isSensitive	Boolean	プロパティ値で機密データがマスクされているかどうかを示します。

GET応答の例

Secure Agentサービスのデフォルトのプロパティ設定を上書きしたプロパティを要求すると、次の例のような応答を受け取る場合があります。

{
    "Data_Integration_Server": [
       {
        "TOMCAT_CFG": [
           {
            "name": "MySQL_JDBC_DRIVER_JARNAME",
            "value": "mysql-connector-java-8.0.13.jar"
           },
           {
            "name": "NetworkTimeoutPeriod",
            "value": "335"
           }
         ]
       },
       {
        "PMRDTM_CFG": [
           {
            "name": "SalesforceConnectionTimeout",
            "value": "311"
           },
           {
            "name": "customConfig-DTM-DIX-linux",
            "value": "custom-new",
            "isCustom": "true"
           }
         ]
       }
    ]
}

PUT要求

Secure AgentグループのSecure Agentサービスプロパティを設定するために使用します。設定したプロパティによって、指定されたSecure Agentサービスのデフォルトのプロパティ設定が上書きされます。URIにSecure AgentグループのIDを含めます。

必要に応じて、URIにプラットフォームを含めます。linux64またはwin64を使用できます。デフォルトのプラットフォームはlinux64です。

次のURIを使用します。

/api/v2/runtimeEnvironment/<id>/configs/<platform>

要求の本文には、次の例のように、Secure Agentサービス名、プロパティタイプ、およびプロパティの名前と値のペアを含めます。

{
    "<Secure Agent service name>": [
       {
        "<Property type 1>": [
           {
            "name": "<property name>",
            "value": "<property value>"
           },
           {
            "name": "<property name>",
            "value": "<property value>"
           }
         ]
       },
       {
        "<Property type 2>": [
           {
            "name": "<property name>",
            "value": "<property value>"
           },
           {
            "name": "<property name>",
            "value": "<property value>"
           }
         ]
       }
    ]
}

GET応答に示されているサービス名とプロパティ名を使用します。例えば、データ統合サーバーサービスの場合は、

Data_Integration_Server

を使用します。

要求に含めないプロパティでは、既存の設定が保持されます。

プロパティタイプのオブジェクトに次のフィールドを含めます。

フィールド	タイプ	必須	説明
name	String	○	プロパティ名。
value	String	○	Secure Agentグループに追加されたすべてのエージェントに使用する値。システムのデフォルト値を使用するには、APP_DEFAULTを使用します。
isCustom	Boolean	-	プロパティがカスタムプロパティかどうかを示します。デフォルトはFalseです。
isSensitive	Boolean	-	プロパティ値で機密データがマスクするかどうかを示します。デフォルトはFalseです。

成功した場合は成功コードを返し、失敗した場合はエラーを返します。

PUT要求の例

データ統合サーバーサービスのTOMCAT_CFGプロパティタイプを設定する場合、要求は次の例のようになります。

PUT <serverUrl>/api/v2/runtimeEnvironment/00000425000000000004/configs
Accept:application/json
icSessionId: <icSessionId>
{
    "Data_Integration_Server": [
       {
        "TOMCAT_CFG": [
           {
            "name": "MySQL_JDBC_DRIVER_JARNAME",
            "value": "mysql-connector-java-8.0.14.jar"
           },
           {
            "name": "customConfig-Tomcat-DIS-linux",
            "value": "custom-new",
            "isCustom": "true"           
           }
         ]
       }
    ]
}

DELETE要求

Secure Agentグループに設定されたSecure Agentサービスのプロパティ設定を削除できます。グループレベルのプロパティを削除すると、グループ内のすべてのSecure Agentの設定がSecure Agentサービスのデフォルト設定に変更されます。Secure Agentグループ用に作成されたカスタムプロパティは削除されます。

Secure Agentグループのプロパティ設定を削除するには、次のURIにSecure AgentグループのIDを含めます。