agentFileOperationTask リソース

この Web サービスは、リモート システムのエージェント ディレクトリにファイル(たとえば、エージェント構成ファイル)をプッシュするのに使用できます。また、ディレクトリからファイルを削除することもできるようになります。このリソースは、エージェントに対して実行されたファイルのコピー操作のリストを取得するのに使用することもできます。
apmdevops102jp
この Web サービスは、リモート システムのエージェント ディレクトリにファイル(たとえば、エージェント構成ファイル)をプッシュするのに使用できます。また、ディレクトリからファイルを削除することもできるようになります。このリソースは、エージェントに対して実行されたファイルのコピー操作のリストを取得するのに使用することもできます。
サポートされている動詞: GET、HEAD、POST、DELETE、OPTIONS
サポートされているパラメータ: pagesizesort
注:
デフォルトでは、POST および DELETE メソッドと API ファイル リソースへのファイルのプッシュは無効になっていて、「許可されていない」という応答が返されます。この機能を有効にするには、apmcccsrv.properties ファイルを編集します。
POST
以下の要求は、ID が 12 のファイルを ID が 2 のエージェントの構成ディレクトリに「my-new-app.pbd」ファイルとしてコピーします。この要求は、エージェントが実行されているサーバから送信されます。
POST https://localhost:8443/apm/acc/agentFileOperationTask
{
  "agent" : "agent/2",
  "file" : "file/12",
  "destination" : "core/config/my-new-app.pbd”,
  "operation":"COPY"
}
以下の要求は、「my-new-app.pbd」構成ファイルを削除します。
POST https://localhost:8443/apm/acc/agentFileOperationTask
{
  "agent" : "agent/2",
  "destination" : "core/config/my-new-app.pbd”,
  "operation":"DELETE"
}
POST できるのは、以前に構成サーバのファイル リソース(URL https://<host>:8443/apm/acc/file)にプッシュされたファイル、または診断レポートの一部であるファイルのみであることに注意してください。
リソースのプロパティ
リソースに関する情報が含まれる以下のプロパティを使用できます。
プロパティ名
タイプ
説明
API バージョン
status
列挙
操作のステータス(タスク リソースの定義に従います)。
1.0
creationTimestamp
日付
リソースが作成された時間(UTC)。
1.0
completionTimestamp
日付
操作が完了した時間(UTC)。
1.0
expectedDuration
整数
実行中の操作にかかる予定時間。
1.0
source
文字列
エージェントにプッシュするファイル(構成サーバの fileUploads dir を基準にした相対パス)。
1.0
destination
文字列
更新または削除するファイルの場所(エージェントのインストール ディレクトリを基準にした相対パス)。
1.0
オペレーション
列挙
実行する操作: 「COPY」または「DELETE」。
1.0
agentId
整数
操作が実行されるエージェントの一意の識別子。
1.0
user
文字列
操作を開始したユーザ。
1.0
updateErrors
配列
操作中に返されたエラーの配列。
1.0