REST APIリファレンス

前へ次へ

Secure Agentサービス

エージェントサービスリソースを使用して、Secure Agentサービスを停止または開始します。

Secure Agentサービスを開始または停止するためのPOST要求を送信した後で、REST API V2エージェントリソースを使用してサービスのステータスをチェックできます。

POST要求

Secure Agentサービスを停止または開始するには、次のURIを使用します。

public/core/v3/agent/service

要求に次のフィールドを含めます。

フィールド	タイプ	必須	説明
serviceName	String	○	開始または停止するSecure Agentサービスの名前を表示します。
serviceAction	String	○	Secure Agentサービスで実行するアクション。次のいずれかの値を含めます。 start。Secure Agentサービスの最新バージョンを開始します。 stop。Secure Agentサービスのすべてのバージョンを停止します。
agentId	String	○	Secure Agentサービスが配置されているエージェントのID。 IDを検索するには、エージェントパスを含むlookup POST要求を送信します。

POST応答

要求が成功した場合、応答には次のいずれかのサービスの状態が含まれます。

状態	説明
NEED_RUNNING	開始プロセスは開始済みです。
NEED_STOP	停止プロセスは開始済みです。
DEPLOYING	サービスはプロビジョニング済みです。
DEPLOYED	サービスはデプロイ済みで、まもなく実行されます。
UNKNOWN	ステータスは不明です。REST APIバージョン2エージェントリソースを使用してステータスをチェックします。ステータスを検索するには、エージェントパスを含むlookup POST要求を送信します。
ERROR	サービスはエラー状態です。
STARTING	サービスは起動中です。
RUNNING	サービスは実行中で、ジョブを受け入れる準備が整いました。
RESTARTING	サービスは再起動中で、まもなく実行されます。
STOPPING	サービスがシャットダウンしています。
USER_STOPPED	サービスはユーザーにより停止されました。

POST要求の例

Secure Agentサービスを開始するには、次の例のような要求を送信します。

POST <baseApiUrl>/public/core/v3/agent/service
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "serviceName":"Data Integration",
    "serviceAction":"start",
    "agentId":"kiphQJoRWWJfaC3enJ1smP"
}

POST応答の例

要求が成功した場合、次の例のような応答を受信します。

{
    "serviceState":"STARTING",
    "message":"Successfully initiated start action. Note that only the latest version of the service will be started. Send a GET request to  /v2/agent/details API to check the updated status of the service."
}

プラットフォームREST APIバージョン3リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal