Secure Agentとサービス
このリソースを使用して、Secure Agentの登録、エージェントインストールプログラムのチェックサムのダウンロード、Informatica Cloud Secure AgentまたはSecure Agentサービスの詳細の要求、またはSecure Agentの削除を行うためのインストールトークンを受け取ります。
Secure AgentインストールトークンのGET要求およびチェックサム
Secure Agent登録プロセスを完了できるようにインストールトークンを要求するか、エージェントインストールプログラムのチェックサムを取得するには、次のようにURIにプラットフォームタイプを含めます。
/api/v2/agent/installerInfo/<platform>
プラットフォームには次のいずれかの値を使用します。
Secure AgentインストールトークンのGET応答およびチェックサム
要求が正常に実行されると、次の応答例に示すように、ダウンロードURL、インストールトークン、チェックサムのダウンロードURLが返されます。
{
"@type": "agentInstallerInfo",
"downloadUrl": "https://pdm.ics.dev/package-manager/files/binary/agent64_install_ng_ext/6403/win64/agent64_install_ng_ext.6403.exe",
"installToken": "PJ7NVrQ0SGpnpbmJ8K5yte18HLDw305DwPgP_jxG1R4KiOY9BL6qxV7jWiv7wSEfg7mQHKRWX6kcEVph1xjswX",
"checksumDownloadUrl": "https://pdm.ics.dev/package-manager/files/binary/agent64_install_ng_ext/6403/win64/agent64_install_ng_ext.6403_win64.sha256"
}
Windowsでチェックサムを確認するには、HashMyFilesや7-Zipなどのサードパーティユーティリティを使用して、Secure Agentインストールプログラムのチェックサムを見つけ、checksum.txtファイルのチェックサムと比較します。ハッシュアルゴリズムはCRC-32です。
Linuxでチェックサムを確認するには、cksum <Secure Agent installer filename>コマンドを実行し、checksum.txtファイルのチェックサムと比較します。コマンド出力の最初の列はチェックサムです。
エージェント詳細のGET要求
Secure Agentの詳細、またはSecure Agentで実行するサービスの詳細を要求できます。
- Secure Agentの詳細
- 組織内のすべてのSecure Agentの詳細を要求するには、次のURIを使用します。
/api/v2/agent
- 現在どのグループにも割り当てられていないすべてのSecure Agentのリストを要求するには、次のURIを使用します。
/api/v2/agent/?includeUnassignedOnly=true
- 特定のSecure Agentの詳細を要求するには、URIにSecure Agent IDまたはSecure Agent名を含めることができます。次のいずれかのURIを使用します。
/api/v2/agent/<agent ID>
/api/v2/agent/name/<name>
- 要求にSecure Agent名を使用し、Secure Agent名にスペースが含まれる場合は、スペースを%20で置き換えます。以下に例を示します。
/api/v2/agent/name/special%20agent
- Secure Agentサービスのステータスと詳細
- 組織内のすべてのSecure Agentで実行されているサービスのステータスを要求するには、次のURIを使用します。
/api/v2/agent/details
- 特定のSecure Agentで実行されているサービスのステータスを要求するには、URIにエージェントIDを次のように含めます。
/api/v2/agent/details/<agent ID>
- 応答にステータスに加えてSecure Agentの詳細を含める場合は、要求に次のパラメータを含めます: ?onlyStatus=false。例えば、次の要求は、指定されたSecure AgentのagentEngineStatusオブジェクトとagentEngineConfigsオブジェクトを返します。
/api/v2/agent/details/<agent ID>?onlyStatus=false
エージェント詳細のGET応答
要求されたSecure Agent IDまたはSecure Agent名のエージェントオブジェクトを返します。
組織内のすべてのSecure Agentに関する情報を要求すると、組織内の各Secure Agentのエージェントオブジェクトが返されます。
エージェントサービスの詳細を要求すると、エージェントオブジェクトとともにAgentEngineオブジェクトが返されます。
エラーが発生した場合にエラーオブジェクトを返します。
エージェントオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
---|
id | String | Secure Agent ID。 |
orgId | String | 組織ID。 |
name | String | Secure Agentの名前。 |
description | String | Secure Agentの説明。 |
createTime | Date/Time | Secure Agentが作成された時刻。 |
updateTime | Date/Time | Secure Agentが更新された最終時刻。 |
createdBy | String | Secure Agentを作成したユーザー。 |
updatedBy | String | Secure Agentを更新したユーザー。 |
active | Boolean | Secure Agentがアクティブかどうかを示します。trueまたはfalseを返します。 |
readyToRun | Boolean | Secure Agentでタスクの実行準備ができているかどうかを示します。trueまたはfalseを返します。 |
platform | String | Secure Agentマシンのプラットフォーム。次のいずれかの値を返します。 |
agentHost | String | Secure Agentマシンのホスト名。 |
proxyHost | String | Secure Agentが使用する送信プロキシサーバーのホスト名。 |
proxyPort | Int | 送信プロキシサーバーのポート番号。 |
proxyUser | String | 送信プロキシサーバーに接続するユーザー名。 |
agentVersion | String | Secure Agentのバージョン。 |
spiUrl | String | このフィールドは適用されなくなり、非推奨になりました。 |
upgradeStatus | String | アップグレードステータス。 |
lastUpgraded | Date/Time | Secure Agentがアップグレードされた最終時刻。 |
lastUpgradeCheck | Date/Time | Secure Agentのアップグレードが確認された最終時刻。 |
lastStatusChange | Date/Time | Secure Agentステータスが更新された最終時刻。 |
packages | String | このフィールドは適用されなくなり、非推奨になりました。 |
configUpdateTime | Date/Time | ユーザーがSecure Agentプロパティを更新した最終時刻。 |
agentGroupId | String | Secure AgentグループのID。 |
agentConfigs | | このオブジェクトは適用されません。これは廃止されました。 |
name | String | agentConfigオブジェクトに含まれています。 廃止されました。 |
type | String | agentConfigオブジェクトに含まれています。 推奨されていません。 |
subtype | String | agentConfigオブジェクトに含まれています。 推奨されていません。 |
value | String | agentConfigオブジェクトに含まれています。 推奨されていません。 |
customized | Boolean | agentConfigオブジェクトに含まれています。 推奨されていません。 |
overridden | Boolean | agentConfigオブジェクトに含まれています。 推奨されていません。 |
defaultValue | String | agentConfigオブジェクトに含まれています。 推奨されていません。 |
platform | String | agentConfigオブジェクトに含まれています。 推奨されていません。 |
Secure Agentで実行するサービスの詳細を要求する場合、エージェントオブジェクトにはAgentEngineオブジェクトも含まれます。AgentEngineオブジェクトには次の属性が含まれます。
フィールド | タイプ | 説明 |
---|
agentEngineStatus | | AgentEngineStatusオブジェクトに関する情報を含むエージェントサービスのステータス。 |
appname | String | AgentEngineStatusオブジェクトに含まれています。 内部で使用されるサービス名。 |
appDisplayName | String | AgentEngineStatusオブジェクトに含まれています。 ユーザーインタフェースに表示されるサービス名。 |
appversion | String | AgentEngineStatusオブジェクトに含まれています。 サービスのバージョン。サービスを変更するたびにバージョン番号が変更されます。 |
replacePolicy | - | 内部目的でのみ使用されます。 |
status | String | AgentEngineStatusオブジェクトに含まれています。 サービスのステータス。可能な値は次のとおりです。 - - RUNNING。サービスは実行中で、ジョブを受け入れる準備が整っています。
- - DEPLOYING: サービスはプロビジョニング中です。
- - STOPPED。サービスは停止されています。
- - ERROR。サービスはエラー状態です。
- - NEED_RUNNING。開始プロセスが開始するように設定されているか、すでに開始されています。
- - NEED_STOP。停止プロセスが開始するように設定されているか、すでに開始されています。
|
desiredStatus | - | 内部目的でのみ使用されます。 |
subState | String | AgentEngineStatusオブジェクトに含まれています。 値0は、サービスが実行されていることを示します。その他のすべての値は、サービスが実行されていないことを示します。 |
createTime | Date/Time | AgentEngineStatusオブジェクトに含まれています。 サービスが作成された時刻。 |
updateTime | Date/Time | AgentEngineStatusオブジェクトに含まれています。 サービスの最終更新時刻。 |
agentEngineConfigs | | エージェントサービスのプロパティを定義します。各エージェントサービスプロパティではengineConfigオブジェクトに関する情報を含みます。 要求にパラメータstatusOnly=falseが含まれている場合に含まれます。 |
type | String | engineConfigオブジェクトに含まれています。 設定タイプ。 |
name | String | engineConfigオブジェクトに含まれています。 設定プロパティの名前。 |
value | String | engineConfigオブジェクトに含まれています。 プロパティの値。 |
platform | String | engineConfigオブジェクトに含まれています。 プラットフォーム。次のいずれかの値を返します。 |
customized | Boolean | engineConfigオブジェクトに含まれています。 プロパティがカスタム構成の詳細に含まれているかどうかを示します。trueまたはfalseを返します。 |
成功時の応答は以下の例のようになります。
GETの例
10044030000000000GCというIDを持つ、JSON形式で返されるSecure Agentに関する詳細を要求するには、次の要求を使用します。
GET <serverUrl>/api/v2/agent/10044030000000000GC HTTP/<HTTP version>
Content-Type: application/json
Accept: application/json
icSessionId: <icSessionId>
成功時の応答の例を以下に示します。
{
"@type": "agent",
"id": "10044030000000000GC",
"orgId": "010025",
"name": "MyAgent",
"createTime": "2021-02-25T00:42:39:000Z",
"updateTime": "2021-02-25T00:42:39:000Z",
"createdBy": "larry104",
"updatedBy": "larry104",
"active": "false",
"readyToRun": "false",
"platform": "linux64",
"agentHost": "agentHost5",
"serverUrl": "https://na4.dm-us.informaticacloud.com/saas",
"proxyPort": "0",
"upgradeStatus": "NotUpgrading",
"federatedId": "6iPQuOsH1YAfnJvhZWPZjI",
"createTimeUTC": "2021-02-25T00:42:39:000Z",
"updateTimeUTC": "2021-02-25T00:42:39:000Z",
"agentGroupId": "01000125000000000002"
}
DELETE要求
Secure Agentがどの接続にも関連付けられていない場合、Secure Agentを削除できます。Secure Agentを削除する前に、関連付けられている接続を更新して別のSecure Agentを使用します。
Secure Agentを削除するには、次のURIでSecure Agent IDを使用します。
/api/v2/agent/<id>
DELETE応答
要求に成功した場合に200の応答コードを返します。
エラーが発生した場合にエラーオブジェクトを返します。