Agent Client Collector API

Agent Client Collector - GET /agents/{agent_id}

指定されたエージェントの情報を取得します。

URL 形式

/api/sn_agent/agents/{agent_id}

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 2. クエリパラメーター
名前	説明
なし

表 : 3. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 5. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_user ロールがありません。
404	指定された ID のエージェントが見つかりません。

応答本文のパラメーター (JSON)


名前	説明
<Array>	エージェントの詳細情報を含む JSON オブジェクトのアレイ。 `{ "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" }`
agent_id	送信されたエージェントの ID。データタイプ：文字列
data_collection	データ収集は、スケジュールされたチェックを実行するかどうかを示します。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。可能な値： 0：オン - チェックがスケジュールどおりに実行されます。 1：オフ (手動) – チェックは手動で無効にされています。 2：オフ (自動) - CPU の消費量が多いため、チェックが自動的に無効になりましたデータタイプ：数値
ip_address	エージェントの IP アドレス。データタイプ：文字列
is_duplicate	このエージェントが別のエージェントの複製であるかどうかを示すフラグ。指定されたホストには 1 つのエージェントのみが存在している必要があります。可能な値： true：エージェントは、異なるエージェント ID を持つアライブ/稼動エージェントと同じホストを持っています。重複をオフにするかアンインストールします false：このエージェントには、アライブ/稼働ステータスの重複はありません。データタイプ：ブール
is_restart_enabled	再起動が有効かどうかを示すフラグ。エージェントの再起動は構成できません。OS と、エージェントが実行されている OS のバージョンによって異なります。可能な値： true：このエージェントの再起動が有効です。 false：このエージェントの再起動が無効です。データタイプ：ブール
name	エージェントの名前。データタイプ：文字列
number_of_running_checks	エージェントの実行がスケジュールされているチェックの数。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。データタイプ：数値
status	エージェントのステータス。可能な値： 0：アライブ/稼動 – エージェントはアクティブです。 1：警告 - エージェントは過去数分間にキープアライブメッセージを受信していません。 2：停止 - エージェントが長期間にわたってキープアライブメッセージを受信していません。 3：再起動中 - エージェントを再起動しています。データタイプ：数値
up_since	エージェントのステータスがアライブ/稼働になってからの UTC 時間。値は GlideDateTime 形式です。データタイプ：文字列
version	エージェントが実行しているエージェントクライアントコレクターのバージョン。データタイプ：文字列

cURL 要求

次の例は、エージェントの詳細を取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "name": "WIN-V26KAP7PI2G",
  "status": 2,
  "agent_id": "074b14e2eb3ce9d4",
  "ip_address": "10.196.55.14",
  "number_of_running_checks": 11,
  "data_collection": 0,
  "is_restart_enabled": true,
  "is_duplicate": false,
  "up_since": "2021-03-31 12:02:17",
  "version": "2.3.0"
}

Agent Client Collector - GET /agents/{agent_id}/data/off

ステータスが稼働/アライブの指定エージェントでデータ収集を無効にします。

エージェントのデータ収集がオンかオフかを判断するには、GET /agents/{agent_id} エンドポイントを実行します。

URL 形式

/api/sn_agent/agents/{agent_id}/data/off

サポートされている要求パラメーター

表 : 7. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 8. クエリパラメーター
名前	説明
なし

表 : 9. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 10. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 11. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 12. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	エージェントが見つからないか、稼働中/アライブステータスではありません。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、エージェントのデータ収集を無効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/off" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
"message": "Data Collection Disabled For Agent With ID: <agent_id>"
}

Agent Client Collector - GET /agents/{agent_id}/data/on

ステータスが稼働/アライブの指定エージェントでデータ収集を有効にします。

エージェントのデータ収集がオンかオフかを判断するには、GET /agents/{agent_id} エンドポイントを実行します。

URL 形式

/api/sn_agent/agents/{agent_id}/data/on

サポートされている要求パラメーター

表 : 13. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 14. クエリパラメーター
名前	説明
なし

表 : 15. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 16. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 17. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 18. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	エージェントが見つからないか、稼働中/アライブステータスではありません。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、エージェントのデータ収集を有効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/on" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "message": "Data Collection Enabled For Agent With ID: <agent_id>"
}

Agent Client Collector - GET /agents/{agent_id}/discovery

検出チェックを実行して、エージェントに関連する CI を特定します。指定されたエージェントは、アライブ/稼働ステータスである必要があります。

URL 形式

/api/sn_agent/agents/{agent_id}/discovery

サポートされている要求パラメーター

表 : 19. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 20. クエリパラメーター
名前	説明
なし

表 : 21. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 22. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 23. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 24. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	エージェントが見つからないか、稼働中/アライブステータスではありません。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、アライブ/稼働ステータスのエージェントで検出を実行する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/discovery" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "message": "Running Discovery For Agent With ID: <agent_id>"
}

Agent Client Collector - GET /agents/check_defs/{check_def_id}

詳細を含む指定されたチェック定義を取得します。

URL 形式

/api/sn_agent/agents/check_defs/{check_def_id}

サポートされている要求パラメーター

表 : 25. パスパラメーター
名前	説明
check_def_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。データタイプ：文字列

表 : 26. クエリパラメーター
名前	説明
なし

表 : 27. 要求本文パラメーター (JSON)
名前	説明
X-Include-Check-Params	既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。有効な値： true：チェックパラメーターの詳細を返します。 false：チェックパラメーターの詳細を返しません。データタイプ：ブーリアンデフォルト値：False

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 28. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 29. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 30. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
404	指定された sys_id のチェック定義が見つかりませんでした。

応答本文のパラメーター (JSON)


プロパティ	説明
check	指定されたチェック定義の詳細。 `{ "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "error": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number }`
background	このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するまで待機しないチェックです。有効な値： true：このチェック定義はバックグラウンドチェックです。 false：このチェック定義はバックグラウンドチェックではありません。データタイプ：ブール
check_group	このチェック定義に指定されたグループ。データタイプ：文字列
check_type	チェックのタイプ。可能な値： Events：チェック結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
command	エージェントクライアントコレクターが実行するコマンド。データタイプ：文字列
error	エラーがある場合のメッセージ。それ以外の場合は Null です。データタイプ：文字列
name	チェックの名前。データタイプ：文字列
params	チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 `"params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ]` データタイプ：アレイ
params.active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブール
params.default_value	このチェックパラメーターのデフォルト値を指定します。データタイプ：文字列
params.mandatory	チェックパラメーターが必須かどうかを示すフラグ。有効な値： true：チェックパラメーターは必須です。 false：チェックパラメーターはオプションです。データタイプ：ブール
params.name	チェックパラメーターの名前。データタイプ：文字列
params.sys_id	チェックセキュアパラメーター定義 [sn_agent_check_param_def] テーブルにリストされたチェックパラメーターの sys_id。データタイプ：文字列
plugins	このチェックに関連付けられたエージェントクライアントコレクタープラグインのリスト。データタイプ：アレイ
proxy_valid	チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。有効な値： true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。データタイプ：ブール
secure_params	このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 `"secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ]` データタイプ：アレイ
secure_params.active	セキュアパラメーターがアクティブかどうかを示すフラグ。有効な値： true：セキュアパラメーターはアクティブです。 false：セキュアパラメーターは非アクティブです。データタイプ：ブール
secure_params.name	セキュアパラメーターの名前。データタイプ：文字列
secure_params.order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：数値
secure_params.sys_id	チェックセキュアなパラメーター定義 [sn_agent_check_secure_param_def] テーブルにリストされたセキュアパラメーターの sys_id。データタイプ：文字列
sys_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。データタイプ：文字列
timeout	タイムアウト (秒)。データタイプ：数値

cURL 要求

次の例は、指定されたチェック定義の情報を取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/94436b237f705300f128134f8dfa91a4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力:

{
  "name": "app.apache.metrics-apache",
  "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}",
  "plugins": [
    "monitoring-plugin-common"
  ],
  "timeout": 60,
  "proxy_valid": true,
  "background": false,
  "check_type": "Metrics",
  "check_group": "Apache",
  "sys_id": "94436b237f705300f128134f8dfa91a4",
  "params": [
    {
      "name": "port",
      "active": true,
      "mandatory": true,
      "default_value": "80",
      "sys_id": "58436b237f705300f128134f8dfa91a8"
    },
    {
      "name": "path",
      "active": true,
      "mandatory": true,
      "default_value": "/server-status?auto",
      "sys_id": "98436b237f705300f128134f8dfa91aa"
    },
    {
      "name": "scheme",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "a4e57a96db3bbb4035305c55dc9619f6"
    },
    {
      "name": "host",
      "active": true,
      "mandatory": true,
      "default_value": "127.0.0.1",
      "sys_id": "d4436b237f705300f128134f8dfa91a6"
    },
    {
      "name": "ssl_secure_connection",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "e3b272c4530100106ffeddeeff7b1275"
    }
  ],
  "secure_params": [
    {
      "name": "cred_user_name",
      "active": true,
      "order": 1,
      "sys_id": "2494cd6e53170010f42cddeeff7b1273"
    },
    {
      "name": "cred_password",
      "active": true,
      "order": 2,
      "sys_id": "35948d6e53170010f42cddeeff7b127f"
    }
  ]
}

Agent Client Collector - GET /agents/check_defs/list

詳細を含むチェック定義のリストを取得します。

URL 形式

/api/sn_agent/agents/check_defs/list

サポートされている要求パラメーター

表 : 31. パスパラメーター
名前	説明
なし

表 : 32. クエリパラメータ
名前	説明
なし

表 : 33. 要求本文パラメーター (JSON)
名前	説明
X-Enc-Query	チェック定義結果リストをフィルタリングするためのエンコードされたクエリ文字列。システム内のチェック定義のフィルタリングされていないリストには null を使用します。データタイプ：文字列
X-Include-Check-Params	既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。有効な値： true：チェックパラメーターの詳細を返します。 false：チェックパラメーターの詳細を返しません。データタイプ：ブーリアンデフォルト値：False
X-Limit	返されるレコードの数を制限します。デフォルト値を使用するには、null に設定します。データタイプ：数値デフォルト：20,000

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 34. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 35. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 36. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。

応答本文のパラメーター (JSON)


名前	説明
チェック定義	JSON オブジェクトとして指定されたチェック定義と詳細のリスト。 `[ { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } ]` データタイプ：アレイ
background	このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するまで待機しないチェックです。有効な値： true：このチェック定義はバックグラウンドチェックです。 false：このチェック定義はバックグラウンドチェックではありません。データタイプ：ブール
check_group	このチェック定義に指定されたグループ。データタイプ：文字列
check_type	チェックのタイプ。可能な値： Events：チェック結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
command	エージェントクライアントコレクターが実行するコマンド。データタイプ：文字列
name	チェックの名前。データタイプ：文字列
params	チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 `"params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ]` データタイプ：アレイ
params.active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブール
params.default_value	このチェックパラメーターのデフォルト値を指定します。データタイプ：文字列
params.mandatory	チェックパラメーターが必須かどうかを示すフラグ。有効な値： true：チェックパラメーターは必須です。 false：チェックパラメーターはオプションです。データタイプ：ブール
params.name	チェックパラメーターの名前。データタイプ：文字列
params.sys_id	チェックセキュアパラメーター定義 [sn_agent_check_param_def] テーブルにリストされたチェックパラメーターの sys_id。データタイプ：文字列
プラグイン	このチェックに関連付けられたエージェントクライアントコレクタープラグインのリスト。データタイプ：アレイ
proxy_valid	チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。有効な値： true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。データタイプ：ブール
secure_params	このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 `"secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ]` データタイプ：アレイ
secure_params.active	セキュアパラメーターがアクティブかどうかを示すフラグ。有効な値： true：セキュアパラメーターはアクティブです。 false：セキュアパラメーターは非アクティブです。データタイプ：ブール
secure_params.name	セキュアパラメーターの名前。データタイプ：文字列
secure_params.order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：数値
secure_params.sys_id	チェックセキュアなパラメーター定義 [sn_agent_check_secure_param_def] テーブルにリストされたセキュアパラメーターの sys_id。データタイプ：文字列
sys_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。データタイプ：文字列
timeout	タイムアウト (秒)。データタイプ：数値

cURL 要求

次の例は、パラメーター値を持つ 2 つのチェック定義のリストを取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "check_definitions": [
    {
      "name": "checks_api_test",
      "command": "echo hello",
      "plugins": [],
      "timeout": 9,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "7f1f9026dba530106f4810284b96194f",
      "params": [],
      "secure_params": [
        {
          "name": "check_api_test_check_secure_param2",
          "active": true,
          "order": 2,
          "sys_id": "2d30a066dba530106f4810284b9619c1"
        },
        {
          "name": "check_api_test_check_secure_param1",
          "active": true,
          "order": 100,
          "sys_id": "4c20a066dba530106f4810284b9619a8"
        }
      ]
    },
    {
      "name": "checks_api_test222",
      "command": "echo hello1212121",
      "plugins": [],
      "timeout": 60,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "99e12466dba530106f4810284b961976",
      "params": [
        {
          "name": "check_api_test_check_param_222",
          "active": true,
          "mandatory": false,
          "default_value": "test_test_test",
          "sys_id": "44026466dba530106f4810284b9619b2"
        }
      ],
      "secure_params": []
    }
  ]
}

Agent Client Collector - GET /agents/exec/background/stop/{request_id}

バックグラウンドチェックを停止します。

バックグラウンドチェックを開始するには、POST /agents/check_defs/{check_def_id}/run API を使用します。

URL 形式

/api/sn_agent/agents/exec/background/stop/{request_id}

サポートされている要求パラメーター

表 : 37. パスパラメーター
名前	説明
request_id	POST /agents/check_defs/{check_def_id}/run API を実行して生成されたバックグラウンドチェック要求の ID。

表 : 38. クエリパラメーター
名前	説明
なし

表 : 39. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 40. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 41. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 42. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
404	指定された ID の要求が見つかりません。

応答本文のパラメーター (JSON)


名前	説明
なし

cURL 要求

次の例は、バックグラウンドチェックを停止する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/exec/background/stop/02359174db2a30108a0751f4f3961997" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Agent Client Collector - GET /agents/exec/run/{request_id}

指定された ID の要求のステータスを取得します。

URL 形式

/api/sn_agent/agents/exec/run/{request_id}

サポートされている要求パラメーター

表 : 43. パスパラメーター
名前	説明
request_id	POST /agents/check_defs/{check_def_id}/run API を実行して生成されたバックグラウンドチェック要求の ID。

表 : 44. クエリパラメーター
名前	説明
なし

表 : 45. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 46. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 47. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 48. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
202	要求が進行中であることを示す、指定された ID のメッセージ。
400	要求本文で指定された引数にエラーがあります。
404	指定された ID の要求が見つかりません。
408	指定された ID の要求の実行タイムアウト。
500	指定された ID のステータスまたは要求のチェック中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
status	要求ステータス。可能な値： done - チェックに成功しました。 failure – チェックに失敗しました。詳細はエラーメッセージを参照してください。 mid_flow – 要求の出力は MID サーバーによって処理されています。 processing – チェックが進行中です。 timeout – チェックの処理が runCheckForCis() メソッドで設定された時間制限を超えました。データタイプ：文字列
err_msg	エラーメッセージ (存在する場合)。可能な値：関連する CI のエージェントが見つかりません。指定された ID のバックグラウンドチェック要求はありません。指定された ID の要求はありません。指定された ID のテスト結果はありません。要求タイムアウト。データタイプ：文字列

cURL 要求

次の例は、要求のステータスを取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/exec/run/12fed13cdb2a30108a0751f4f3961981" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Agent Client Collector - GET /agents/exec/test/{test_result_id}

指定されたテスト結果のテストチェックステータスを取得します。

URL 形式

/api/sn_agent/agents/exec/test/{test_result_id}

サポートされている要求パラメーター

表 : 49. パスパラメーター
名前	説明
test_result_id	テストチェック要求の作成によって生成されるテスト結果 ID。

表 : 50. クエリパラメーター
名前	説明
なし

表 : 51. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 52. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 53. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 54. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
202	要求が進行中であることを示す、指定された ID のメッセージ。
404	指定された ID の要求が見つかりません。
408	指定された ID の要求の実行タイムアウト。
500	指定された ID の要求のステータスのチェック中にエラーが発生しました。

応答本文のパラメーター (JSON)


プロパティ	説明
status	テスト結果のステータス。可能な値： 0：処理待ち 1：処理中 2：完了 3：指定された ID のテスト結果なしデータタイプ：文字列
output	ステータスを説明する出力。データタイプ：文字列

cURL 要求

次の例は、完了したテストチェック要求の結果ステータスを取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/check_instances/99e12466dba530106f4810284b961976/test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

Agent Client Collector - GET /agents/check_defs/list

関連情報を含むエージェントのリストを取得します。

URL 形式

/api/sn_agent/agents/list

サポートされている要求パラメーター

表 : 55. パスパラメーター
名前	説明
なし

表 : 56. クエリパラメータ
名前	説明
なし

表 : 57. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 58. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
X-Enc-Query	標準の Glide 形式の Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルのエンコードクエリ。「エンコードされたクエリ文字列」を参照してください。
X-Limit	結果をエージェントの最大数に制限します。必要ない場合は、両方に null または undefined を使用します。デフォルト/最大：20,000 データタイプ：数値

表 : 59. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 60. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_user ロールがありません。

応答本文のパラメーター (JSON)


プロパティ	説明
<Array>	エージェントの詳細情報を含む JSON オブジェクトのアレイ。 `[ { "agent_id": "String", "data_collection": Number, "ip_address": "String", "is_duplicate": Boolean, "is_restart_enabled": Boolean, "name": "String", "number_of_running_checks": Number, "status": Number, "up_since": "String", "version": "String" } ]`
agent_id	送信されたエージェントの ID。データタイプ：文字列
data_collection	データ収集は、スケジュールされたチェックを実行するかどうかを示します。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。可能な値： 0：オン - チェックがスケジュールどおりに実行されます。 1：オフ (手動) – チェックは手動で無効にされています。 2：オフ (自動) - CPU の消費量が多いため、チェックが自動的に無効になりましたデータタイプ：数値
ip_address	エージェントの IP アドレス。データタイプ：文字列
is_duplicate	このエージェントが別のエージェントの複製であるかどうかを示すフラグ。指定されたホストには 1 つのエージェントのみが存在している必要があります。可能な値： true：エージェントは、異なるエージェント ID を持つアライブ/稼動エージェントと同じホストを持っています。重複をオフにするかアンインストールします false：このエージェントには、アライブ/稼働ステータスの重複はありません。データタイプ：ブール
is_restart_enabled	再起動が有効かどうかを示すフラグ。エージェントの再起動は構成できません。OS と、エージェントが実行されている OS のバージョンによって異なります。可能な値： true：このエージェントの再起動が有効です。 false：このエージェントの再起動が無効です。データタイプ：ブール
name	エージェントの名前。データタイプ：文字列
number_of_running_checks	エージェントの実行がスケジュールされているチェックの数。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。データタイプ：数値
status	エージェントのステータス。可能な値： 0：アライブ/稼動 – エージェントはアクティブです。 1：警告 - エージェントは過去数分間にキープアライブメッセージを受信していません。 2：停止 - エージェントが長期間にわたってキープアライブメッセージを受信していません。 3：再起動中 - エージェントを再起動しています。データタイプ：数値
up_since	エージェントのステータスがアライブ/稼働になってからの UTC 時間。値は GlideDateTime 形式です。データタイプ：文字列
version	エージェントが実行しているエージェントクライアントコレクターのバージョン。データタイプ：文字列

cURL 要求

次の例は、クエリと数値によって結果を制限する方法を示しています。このクエリーは、ダウンステータスでないすべてのエージェントを最大 2 つの結果とともに返します。

curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--header "X-Enc-Query: agent_extended_info.status!=2" \
--header "X-Limit: 2" \
--user 'username':'password'

出力：

{
   "agents": [
     {
       "name": "007-175",
       "status": 0,
        "agent_id": "007-175",
       "ip_address": "11.222.63.66",
        "number_of_running_checks": 0,
       "data_collection": 0,
       "is_restart_enabled": false,
       "is_duplicate": false,
       "up_since": "2021-03-24 14:36:45",
       "version": "2.4.0"
     },
     {
       "name": "win2016-dc-64bit",
       "status": 0,
       "agent_id": "007-64",
       "ip_address": "10.222.333.42",
       "number_of_running_checks": 1,
       "data_collection": 0,
       "is_restart_enabled": true,
       "is_duplicate": false,
       "up_since": "2021-03-24 11:04:38",
       "version": "2.4.0"
     }
   ]
}

cURL 要求

次の例は、システム内のすべてのエージェントを一覧表示する方法を示しています。この例では、クエリと結果の最大数を使用していません。

curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Agent Client Collector - GET /agents/{agent_id}/log

アライブ/稼働ステータスの指定されたエージェントのログを要求します。

注:

ログを取得してその進捗状況を確認するには、返された要求 ID を GET /agents/log/{request_id}/ エンドポイントに渡します。

URL 形式

/api/sn_agent/agents/{agent_id}/log

サポートされている要求パラメーター

表 : 61. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 62. クエリパラメーター
名前	説明
なし

表 : 63. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 64. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 65. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 66. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	エージェントが見つからないか、稼働中/アライブステータスではありません。

応答本文のパラメーター (JSON)


名前	説明
request_id	Agent Client Collector Requests [sn_agent_request] テーブル内の要求の sys_id。この ID を使用して、GET /agents/log/{request_id}/ エンドポイントでログを取得してその進捗状況を確認できます。データタイプ：文字列

cURL 要求

次の例は、ログ要求 ID を取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<sys_id>/log" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

"request_id": "<sys_id>"

Agent Client Collector - GET /agents/log/{request_id}/

ログ取得要求のステータスを確認します。

GET /api/sn_agent/agents/{agent_id}/log を使用して送信されたログ取得要求の変更を検出します。

URL 形式

/api/sn_agent/agents/log/{request_id}/

サポートされている要求パラメーター

表 : 67. パスパラメーター
名前	説明
request_id	Agent Client Collector Requests [sn_agent_request] テーブル内の要求の sys_id。要求 ID について、GET /api/sn_agent/agents/{agent_id}/log を実行します。データタイプ：文字列

表 : 68. クエリパラメーター
名前	説明
なし

表 : 69. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 70. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 71. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 72. ステータスコード
ステータスコード	説明
200	要求ステータスが完了し、取得されたログの準備ができました。
202	指定された ID のログ取得要求がまだ進行中です。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された ID のログ取得要求が見つかりません。
408	ログ取得要求はタイムアウトしました。
500	ログ取得要求でエラーが発生しました。

応答本文のパラメーター (JSON)


プロパティ	説明
output	ステータスを説明する情報。

cURL 要求

次の例は、要求 ID を使用してログ取得要求のステータスを取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/log/<request_ID>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力 :

{
  "output": "SensuSnReadFile OK: {\"component\":\"agent\",\"level\":\"info\",\"msg\":\"Agent Protection: cpu of all checks: 0%\",\"time\":\"2021-04-05T00:21:41-07:00\"},...
}

Agent Client Collector - GET /agents/policies/list

ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。

URL 形式

/api/sn_agent/agents/policies/list

サポートされている要求パラメーター

表 : 73. パスパラメーター
名前	説明
なし

表 : 74. クエリパラメータ
名前	説明
なし

表 : 75. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 76. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。
X-Enc-Query	オプション。標準の Glide 形式のエンコードされたクエリ文字列。「エンコードされたクエリ文字列」を参照してください。
X-Include-Check-Params	オプション。チェックインスタンスとそのパラメーターを結果に返すかどうかを示すフラグ。有効な値： true：チェックインスタンスとそのパラメーターを結果に含めます。 false：チェックインスタンスとそのパラメーターを結果に含めません。デフォルト値：false データタイプ：ブーリアン
X-Include-Checks-And-Agents	オプション。チェックインスタンスとエージェントを結果に含めるかどうかを示すフラグ。有効な値： true：チェックインスタンスとエージェントを結果に含めます。 false：チェックとエージェントを結果に含めません。デフォルト値：false データタイプ：ブーリアン

表 : 77. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 78. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_user ロールがありません。

応答本文のパラメーター (JSON)

表 : 79. オブジェクト
プロパティ	説明
ポリシー	取得されたポリシーのリスト。特定の要求ヘッダーを使用してクエリした場合は、結果にチェックとエージェントが含まれます。ポリシーの詳細については、「デフォルトのチェックとポリシー」を参照してください。 { "policies": [ { "active": Boolean, "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" } ] } データタイプ：アレイ
policies.active	ポリシーがアクティブかどうかを示すフラグ。有効な値： true：ポリシーはアクティブです。 false:ポリシーはアクティブではありません。データタイプ：ブーリアン
policies.agent_ids	エージェントの一意の ID。これらの結果は、X-Include-Checks-And-Agents ヘッダーパラメーターが true に設定されている場合にのみ表示されます。エージェントの詳細情報を確認するには、GET /agents/{agent_id} エンドポイントで ID を実行します。データタイプ：文字列テーブル:エージェントクライアントコレクター [sn_agent_cmdb_ci_agent] テーブルの [エージェント ID] 列。
policies.checks	チェックインスタンス [sn_agent_check] テーブルにリストされているチェックを定義するオブジェクトのリスト。これらの結果は、X-Include-Checks-And-Agents または X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。データタイプ：オブジェクトのアレイ `"checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ]` [Table (テーブル)]：
policies.checks.active	ポリシーチェックがアクティブかどうかを示すフラグ。有効な値： true：ポリシーチェックはアクティブです。 false：ポリシーチェックはアクティブではありません。データタイプ：ブール
policies.checks.auto_generate	command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。有効な値： true：command プロパティにアクティブなパラメーター値を自動的に入力します。 false:コマンドは自動的に生成されません。データタイプ：ブーリアン
policies.checks.check_type	監視オプションを指定するチェックタイプ。可能な値： Discovery：エージェントに関連する CI を検索するチェック。 Events：チェックの結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
policies.checks.command	エージェントクライアントコレクターが実行するコマンド。テンプレートまたは監視対象 CI から取得されたパラメーター。注: auto_generate が true の場合、このプロパティには parameters オブジェクトにリストされているアクティブなパラメーターのプリフィックスとフラグが自動的に入力されます。データタイプ：文字列
policies.checks.command_prefix	auto_generate プロパティが true の場合、このコマンドが自動生成に使用されます。プリフィックスは、スクリプト名など、静的な (変化しない) コマンドの部分で構成されます。データタイプ：文字列
policies.checks.event_status_change_threshold	新しいイベントが送信される前にチェックの応答ステータスが発生する必要がある連続回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [OK] から [エラー] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、[エラー] ステータスの新しいイベントが生成されます。データタイプ：数値
policies.checks.event_status_repair_threshold	前のイベントをクローズするためにチェックの応答ステータスを連続して改善する必要がある回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [エラー] から [OK] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、前のイベントがクローズされて [OK] ステータスの新しいイベントが生成されます。データタイプ：数値
policies.checks.interval	チェックの実行間隔を秒単位で待機します。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。データタイプ：数値
policies.checks.name	チェックの名前。データタイプ：文字列
policies.checks.sys_id	チェックのSys_id。データタイプ：文字列テーブル:チェックインスタンス [sn_agent_check]
policies.checks.timeout	出力が返されないときにチェックの実行が停止するまでの時間 (秒)。たとえば、値 60 は、チェックを実行して値が返されないまま 60 秒経過したときに実行が停止することを意味します。データタイプ：文字列
policies.cred_alias	認証情報名。データタイプ：文字列テーブル:認証情報 [discovery_credentials]
policies.credential_alias	認証情報エイリアスのSys_id。データタイプ：文字列テーブル:接続および資格情報エイリアス [sys_alias]
policies.filter	指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。データタイプ：文字列
policies.interval	ポリシーチェック間の待機時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。データタイプ：数値
policies.monitored_ci_group	ポリシーに関連付けられた CMDB グループの名前。このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。データタイプ：文字列テーブル:CMDB グループ [cmdb_group]
policies.monitored_ci_script	CI を監視するためのスクリプト。このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。データタイプ：文字列
policies.monitored_ci_type_filter	CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。有効な値： true：チェックグループによるフィルタリングが有効です。 false：チェックグループによるフィルタリングが無効です。データタイプ：ブール
policies.monitored_ci_type_group	CMDB グループタイプによる監視が有効かどうかを示すフラグ。有効な値： true：CMDB グループタイプは有効です。 false：CMDB グループタイプは無効です。データタイプ：ブール
policies.monitored_ci_type_script	CI を監視するためのスクリプトが有効かどうかを示すフラグ。有効な値： true：CI を監視するためのスクリプトは有効です。 false：CI を監視するためのスクリプトは無効です。データタイプ：ブール
policies.name	ポリシーの名前。データタイプ：文字列
policies.publish_status	ポリシーが公開されているかどうかを示します。可能な値： Draft：ポリシーは公開されておらず、更新エンドポイントを使用して編集できます。 Published：ポリシーが公開されています。ドラフト (サンドボックスのコピー) と公開済みのコピーは同じです。 Published*：ポリシーは公開されていますが、ドラフトコピー (サンドボックスビュー) には公開済みコピーにはない変更があります。データタイプ：文字列
policies.sys_id	ポリシーのSys_id。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]
policies.sys_updated_on	ポリシーが最後に更新された日時。データタイプ：文字列
policies.table	ポリシーの監視対象 CI タイプフィールド。このフィールドは、monitored_ci_type_filter が true の場合にのみ適用されます。データタイプ：文字列
policies.params	チェックパラメーターの情報を含むオブジェクトのリスト。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。データタイプ：オブジェクトのアレイ `"params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ]` テーブル:チェックパラメーター [sn_agent_check_param]
policies.params.active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブール
policies.params.flag	チェックの発動時に使用するパラメーターフラグ。データタイプ：文字列
policies.params.mandatory	チェックが必須かどうかを示すフラグ。有効な値： true：このチェックは必須です。 false：このチェックはオプションです。データタイプ：ブール
policies.params.name	パラメーターの名前です。データタイプ：文字列
policies.params.sys_id	パラメーターのSys_id。データタイプ：文字列テーブル:チェックパラメーター [sn_agent_check_param]
policies.params.value	パラメーターの値。データタイプ：文字列
policies.params.value_required	value プロパティによって提供される情報が必須かどうかを示すフラグ。有効な値： true：value プロパティは必須です。 false：value プロパティは null かまたは必須ではありません。データタイプ：ブール
policies.secure_params	チェックセキュアパラメーターの情報を含むオブジェクトのリスト。詳細については、「チェック用のセキュアなパラメーターの作成」を参照してください。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。データタイプ：オブジェクトのアレイ `"secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ]` 表:チェックセキュアなパラメーター [sn_agent_check_secure_param]
policies.secure_params.active	チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックのセキュアなパラメーターはアクティブです。 false：チェックのセキュアなパラメーターは非アクティブです。データタイプ：ブール
policies.secure_params.name	セキュアパラメーターの名前。データタイプ：文字列
policies.secure_params.order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：数値
policies.secure_params.sys_id	レコードの Sys_id。データタイプ：文字列表: チェックセキュアなパラメーター [sn_agent_check_secure_param]

cURL 要求

次の例は、クエリと数値によって結果を制限する方法を示しています。クエリは、関連付けられたエージェントのすべてのアクティブなポリシーと ID を返します。

curl "https://instance.service-now.com/api/sn_agent/agents/policies/list" \
--request GET \
--header "Accept:application/json" \
--header 'X-Enc-Query: active=true ' \
--header 'X-Include-Checks-And-Agents: true' \
--user 'username' : 'password'

出力：

{
  "policies": [
    {
      "name": "Basic Discovery",
      "sys_id": "68bfd27c536113006dfeddeeff7b12be",
      "active": "true",
      "interval": "43200",
      "sys_updated_on": "2020-07-21 10:14:12",
      "monitored_ci_type_filter": "true",
      "filter": "discovery_source=AgentClientCollector^ORlast_discoveredRELATIVELT@dayofweek@ago@14",
      "table": "cmdb_ci_server",
      "monitored_ci_type_script": "false",
      "monitored_ci_script": "/*\n      Provide a script to get monitored CI type. ...",
      "monitored_ci_type_group": "false",
      "monitored_ci_group": "null// group name as seen in cmdb_group table",
      "cred_alias": "null// credential name as seen in discovery_credentials table",
      "credential_alias": "null// credential alias sys id as seen in sys_alias table",
      "publish_status": "Published",
      "checks": [
        {
          "name": "check-discovery-basic",
          "sys_id": "5b10c644c7e10010b9a4362c14c260aa",
          "active": "true",
          "command": "check_discover.rb",
          "command_prefix": "check_discover.rb",
          "auto_generate": "true",
          "timeout": "60",
          "interval": "43200",
          "event_status_change_threshold": null,
          "event_status_repair_threshold": null,
          "check_type": "Discovery"
        }
      ],
      "agent_ids": "b1faba21b066256f,a088b75b1b25b0a0"
    }
  ]
}

Agent Client Collector - GET /agents/policy/activate/{policy_id}

公開されたポリシーをアクティブにします。

公開されたポリシーのリストについては、GET /agents/policies/list を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が Published または Published* である sys_id のみをサポートします。

URL 形式

/api/sn_agent/agents/policy/activate/{policy_id}

サポートされている要求パラメーター

表 : 80. パスパラメーター
名前	説明
policy_id	公開されたポリシーのSys_id。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]

表 : 81. クエリパラメーター
名前	説明
なし

表 : 82. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 83. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 84. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 85. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


ヘッダー	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーをアクティブにする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - GET /agents/policy/deactivate/{policy_id}

公開されたポリシーを無効にします。

公開されたポリシーのリストについては、GET /agents/policies/list を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が Published または Published* である sys_id のみをサポートします。

URL 形式

/api/sn_agent/agents/policy/activate/{policy_id}

サポートされている要求パラメーター

表 : 86. パスパラメーター
名前	説明
policy_id	公開されたポリシーのSys_id。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]

表 : 87. クエリパラメーター
名前	説明
なし

表 : 88. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 89. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 90. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 91. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


ヘッダー	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーを無効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - GET /agents/policy/publish/{policy_id}

ドラフトポリシーを公開します。

公開前にドラフトまたはサンドボックスのコピーを変更するには、次のいずれかのエンドポイントを使用します。

URL 形式

/api/sn_agent/agents/policy/publish/{policy_id}

サポートされている要求パラメーター

表 : 92. パスパラメーター
名前	説明
policy_id	「ドラフト」ステータスまたはサンドボックスのコピーである、ポリシー [sn_agent_policy] テーブル内のポリシーの sys_id。ポリシーおよび公開ステータスを含む詳細のリストについては、GET /agents/policies/list を使用します。ポリシーのサンドボックスコピーを取得するには、GET /agents/policy/sandbox_from_published/{policy_id} を使用します。データタイプ：文字列

表 : 93. クエリパラメーター
名前	説明
なし

表 : 94. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 95. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 96. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 97. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


ヘッダー	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーを公開する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - GET /agents/policy/sandbox_from_published/{policy_id}

公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。

サンドボックスのコピーを使用してポリシーを更新し、公開します。応答本文の sys_id を使用して、次のエンドポイントを操作できます。

公開されたポリシーのリストについては、GET /agents/policies/list を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が Published または Published* である sys_id のみをサポートします。

URL 形式

/api/sn_agent/agents/policy/sandbox_from_published/{policy_id}

サポートされている要求パラメーター

表 : 98. パスパラメーター
名前	説明
policy_id	公開されたポリシーのSys_id。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]

表 : 99. クエリパラメーター
名前	説明
なし

表 : 100. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 101. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 102. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 103. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


プロパティ	説明
<Object>	ポリシーに関連付けられたサンドボックスコピーの拡張詳細。ポリシーの詳細については、「デフォルトのチェックとポリシー」を参照してください。 `{ "active": Boolean" "agent_ids": "String", "checks": [Array], "cred_alias": "String", "credential_alias": "String", "filter": "String", "interval": "Number", "monitored_ci_group": "String", "monitored_ci_script": "String", "monitored_ci_type_filter": Boolean, "monitored_ci_type_group": Boolean, "monitored_ci_type_script": "String", "name": "String", "params": [Array], "publish_status": "String", "secure_params": [Array], "sys_id": "String", "sys_updated_on": "String", "table": "String" }`
アクティブ	ポリシーがアクティブかどうかを示すフラグ。有効な値： true：ポリシーはアクティブです。 false:ポリシーはアクティブではありません。データタイプ：ブーリアン
agent_ids	エージェントの一意の ID。これらの結果は、X-Include-Checks-And-Agents ヘッダーパラメーターが true に設定されている場合にのみ表示されます。エージェントの詳細情報を確認するには、GET /agents/{agent_id} エンドポイントで ID を実行します。データタイプ：文字列テーブル:エージェントクライアントコレクター [sn_agent_cmdb_ci_agent] テーブルの [エージェント ID] 列。
checks	チェックインスタンス [sn_agent_check] テーブルにリストされているチェックを定義するオブジェクトのリスト。 `"checks": [ { "active": Boolean, "auto_generate": Boolean, "check_type": "String" "command_prefix": "String", "command": "String", "event_status_change_threshold": Number, "event_status_repair_threshold": Number, "interval": Number, "name": "String", "sys_id": "String", "timeout": "String" } ]` データタイプ：アレイ
checks.active	ポリシーチェックがアクティブかどうかを示すフラグ。有効な値： true：ポリシーチェックはアクティブです。 false：ポリシーチェックはアクティブではありません。データタイプ：ブール
checks.auto_generate	command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。有効な値： true：command プロパティにアクティブなパラメーター値を自動的に入力します。 false:コマンドは自動的に生成されません。データタイプ：ブーリアン
checks.check_type	監視オプションを指定するチェックタイプ。可能な値： Discovery：エージェントに関連する CI を検索するチェック。 Events：チェックの結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
checks.command	エージェントクライアントコレクターが実行するコマンド。テンプレートまたは監視対象 CI から取得されたパラメーター。注: auto_generate が true の場合、このプロパティには parameters オブジェクトにリストされているアクティブなパラメーターのプリフィックスとフラグが自動的に入力されます。データタイプ：文字列
checks.command_prefix	auto_generate プロパティが true の場合、このコマンドが自動生成に使用されます。プリフィックスは、スクリプト名など、静的な (変化しない) コマンドの部分で構成されます。データタイプ：文字列
checks.event_status_change_threshold	新しいイベントが送信される前にチェックの応答ステータスが発生する必要がある連続回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [OK] から [エラー] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、[エラー] ステータスの新しいイベントが生成されます。データタイプ：数値
checks.event_status_repair_threshold	前のイベントをクローズするためにチェックの応答ステータスを連続して改善する必要がある回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [エラー] から [OK] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、前のイベントがクローズされて [OK] ステータスの新しいイベントが生成されます。データタイプ：数値
checks.interval	チェックの実行間隔を秒単位で待機します。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。データタイプ：数値
checks.name	チェックの名前。データタイプ：文字列
checks.sys_id	チェックのSys_id。POST /agents/update/check/{check_id} エンドポイントは、この値を取得してサンドボックスのコピーを更新します。データタイプ：文字列テーブル:チェックインスタンス [sn_agent_check]
checks.timeout	出力が返されないときにチェックの実行が停止するまでの時間 (秒)。たとえば、値 60 は、チェックを実行して値が返されないまま 60 秒経過したときに実行が停止することを意味します。データタイプ：文字列
cred_alias	認証情報名。データタイプ：文字列テーブル:認証情報 [discovery_credentials]
credential_alias	認証情報エイリアスのSys_id。データタイプ：文字列テーブル:接続および資格情報エイリアス [sys_alias]
filter	指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。データタイプ：文字列
interval	ポリシーチェック間の待機時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。データタイプ：数値
monitored_ci_group	ポリシーに関連付けられた CMDB グループの名前。このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。データタイプ：文字列テーブル:CMDB グループ [cmdb_group]
monitored_ci_script	CI を監視するためのスクリプト。このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。データタイプ：文字列
monitored_ci_type_filter	CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。有効な値： true：チェックグループによるフィルタリングが有効です。 false：チェックグループによるフィルタリングが無効です。データタイプ：ブール
monitored_ci_type_group	CMDB グループタイプによる監視が有効かどうかを示すフラグ。有効な値： true：CMDB グループタイプは有効です。 false：CMDB グループタイプは無効です。データタイプ：ブール
monitored_ci_type_script	CI を監視するためのスクリプトが有効かどうかを示すフラグ。有効な値： true：CI を監視するためのスクリプトは有効です。 false：CI を監視するためのスクリプトは無効です。データタイプ：ブール
name	ポリシーの名前。データタイプ：文字列
publish_status	ポリシーが公開されているかどうかを示します。可能な値： Draft：ポリシーは公開されておらず、更新エンドポイントを使用して編集できます。 Published：ポリシーが公開されています。ドラフト (サンドボックスのコピー) と公開済みのコピーは同じです。 Published*：ポリシーは公開されていますが、ドラフトコピー (サンドボックスビュー) には公開済みコピーにはない変更があります。データタイプ：文字列
params	チェックパラメーターの情報を含むオブジェクトのリスト。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。データタイプ：オブジェクトのアレイ `"params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ]` テーブル:チェックパラメーター [sn_agent_check_param]
params.active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブール
params.flag	チェックの発動時に使用するパラメーターフラグ。データタイプ：文字列
params.mandatory	チェックが必須かどうかを示すフラグ。有効な値： true：このチェックは必須です。 false：このチェックはオプションです。データタイプ：ブール
params.name	パラメーターの名前です。データタイプ：文字列
params.sys_id	チェックパラメーター [sn_agent_check_param] テーブルにリストされたパラメーターの sys_id。POST /agents/update/check_param/{param_id} エンドポイントは、この値を取得してサンドボックスのコピーを更新します。データタイプ：文字列
params.value	パラメーターの値。データタイプ：文字列
params.value_required	value プロパティによって提供される情報が必須かどうかを示すフラグ。有効な値： true：value プロパティは必須です。 false：value プロパティは null かまたは必須ではありません。データタイプ：ブール
secure_params	チェックセキュアパラメーターの情報を含むオブジェクトのリスト。詳細については、「チェック用のセキュアなパラメーターの作成」を参照してください。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。データタイプ：オブジェクトのアレイ `"secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ]` 表:チェックセキュアなパラメーター [sn_agent_check_secure_param]
secure_params.active	チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックのセキュアなパラメーターはアクティブです。 false：チェックのセキュアなパラメーターは非アクティブです。データタイプ：ブール
secure_params.name	セキュアパラメーターの名前。データタイプ：文字列
secure_params.order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：数値
secure_params.sys_id	レコードの Sys_id。POST /agents/update/check_secure_param/{param_id} エンドポイントは、この値を取得してサンドボックスのコピーを更新します。データタイプ：文字列表: チェックセキュアなパラメーター [sn_agent_check_secure_param]
sys_id	ポリシーのSys_id。POST /agents/update/policy/{policy_id} エンドポイントは、この値を取得してサンドボックスのコピーを更新します。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]
sys_updated_on	ポリシーが最後に更新された日時。データタイプ：文字列
table	ポリシーの監視対象 CI タイプフィールド。このフィールドは、monitored_ci_type_filter が true の場合にのみ適用されます。データタイプ：文字列

cURL 要求

Docker コンテナ測定基準ポリシーの情報を取得する方法を次に示します。

curl "https://instance.service-now.com/api/sn_agent/agents/policy/sandbox_from_published/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "name": "Docker Container Metrics",
  "sys_id": "b01e609a1b9fe4943e7f0b05464bcb91",
  "active": "false",
  "interval": "60",
  "sys_updated_on": "2021-04-05 19:52:28",
  "monitored_ci_type_filter": "true",
  "filter": "operational_status=1",
  "table": "cmdb_ci_docker_container",
  "monitored_ci_type_script": "false",
  "monitored_ci_script": "/*\n Provide a script to get monitored CI type.",
  "monitored_ci_type_group": "false",
  "monitored_ci_group": "null// group name as seen in cmdb_group table",
  "cred_alias": "null// credential name as seen in discovery_credentials table",
  "credential_alias": "null// credential alias sys id as seen in sys_alias table",
  "publish_status": "Published",
  "checks": [
    {
      "name": "container.docker.metrics-docker",
      "sys_id": "701e609a1b9fe4943e7f0b05464bcb94",
      "active": "true",
      "command": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}} -P -n -i",
      "command_prefix": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}}",
      "auto_generate": "true",
      "timeout": "60",
      "interval": "60",
      "event_status_change_threshold": null,
      "event_status_repair_threshold": null,
      "check_type": "Metrics",
      "params": [
        {
          "name": "scheme",
          "sys_id": "c11e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-s"
        },
        ...
        {
          "name": "docker_host",
          "sys_id": "cd1e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-H"
        }
      ],
      "secure_params": []
    }
  ]
}

Agent Client Collector - GET /agents/{agent_id}/restart

アライブ/稼働ステータスの指定されたエージェントを再起動します。

エージェントクライアントコレクターのパフォーマンスの問題が発生した場合は、エージェントを再起動できます。手動再起動は次の環境でサポートされています。

systemd を使用する Linux ベースのエージェント
Windows エージェント

URL 形式

/api/sn_agent/agents/{agent_id}/restart

サポートされている要求パラメーター

表 : 104. パスパラメーター
名前	説明
agent_id	Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされるエージェントの一意の ID。エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。データタイプ：文字列

表 : 105. クエリパラメーター
名前	説明
なし

表 : 106. 要求本文パラメーター (JSON)
名前	説明
なし

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 107. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 108. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 109. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つからないか、このエージェントが再起動をサポートしていません。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、エージェントを再起動する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/restart" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

出力：

{
  "message": "Restarting Agent With ID: <agent_id>"
}

Agent Client Collector - POST /agents/check_defs/{check_def_id}/run

指定された構成アイテムに対してチェックを実行します。

バックグラウンドチェックを停止するには、GET /agents/exec/background/stop/{request_id} API で指定された要求 ID を使用します。

URL 形式

/api/sn_agent/agents/check_defs/{check_def_id}/run

サポートされている要求パラメーター

表 : 110. パスパラメーター
名前	説明
check_def_id	チェック定義 [sn_agent_check_def] テーブルのチェック定義の sys_id。

表 : 111. クエリパラメーター
名前	説明
なし

表 : 112. 要求本文パラメーター (JSON)
名前	説明
params	パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 `"params": { "<parameter name>": "String" }` データタイプ：オブジェクト
priority	ECC キューに設定される要求の優先度。可能な値： 0：インタラクティブ 1：迅速化済み 2：標準データタイプ：数値
クエリ	table プロパティで指定されたテーブルから GlideRecord を取得するためのエンコードされたクエリ。データタイプ：文字列
table	このバックグラウンドチェックの cmdb_ci テーブルの名前。データタイプ：文字列
timeout	要求のタイムアウト値 (秒)。データタイプ：数値

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 113. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 114. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 115. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
400	要求本文で指定された引数にエラーがあります。
404	指定された ID のチェック定義が見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


名前	説明
requestId	生成されたバックグラウンドチェック要求の sys_id。

cURL 要求

次の例は、バックグラウンドチェックを実行してその要求 ID を取得する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/a90d3c361be1301060d2773ad54bcb6f/run" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"table\":\"sn_agent_check_def\"}" \
--user 'username':'password'

出力：

{
  "request_id": "278c0170db2a30108a0751f4f3961926"
}

Agent Client Collector - POST /agents/check_defs/{check_def_id}/test

チェック定義に対するテストチェック要求の構築を有効にします。

この API は次のタスクに使用します。

テストするチェック定義を設定
テストを実行するための構成アイテムを設定

テスト中に使用する次のいずれかの識別子を指定することもできます。

資格情報 sys_id
資格情報エイリアス ID
資格情報名

URL 形式

/api/sn_agent/agents/check_defs/{check_def_id}/test

サポートされている要求パラメーター

表 : 116. パスパラメーター
名前	説明
check_def_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。

表 : 117. クエリパラメーター
名前	説明
なし

表 : 118. 要求本文パラメーター (JSON)
名前	説明
ci_id	CMDB 構成アイテムの sys_id
credentials_id	資格情報レコードの sys_id。
credentials_name	資格情報レコードの名前。
credentials_alias_id	資格情報エイリアスレコードの sys_id。
credentials_alias_name	資格情報エイリアスの名前。

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 119. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 120. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 121. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
500	テスト要求の構築中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
result_id	テスト結果レコードの sys_id。

Agent Client Collector - POST /agents/check_instances/{check_instance_id}/test

チェックインスタンスに対するテストチェック要求の構築を有効にします。

この API は次のタスクに使用します。

テストするチェックインスタンスを設定
テストを実行するための構成アイテムを設定

テスト中に使用する次のいずれかの識別子を指定することもできます。

資格情報 sys_id
資格情報エイリアス ID
資格情報名

URL 形式

/api/sn_agent/agents/check_instances/{check_instance_id}/test

サポートされている要求パラメーター

表 : 122. パスパラメーター
名前	説明
check_instance_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。

表 : 123. クエリパラメーター
名前	説明
なし

表 : 124. 要求本文パラメーター (JSON)
名前	説明
ci_id	CMDB 構成アイテムの sys_id
credentials_id	資格情報レコードの sys_id。
credentials_name	資格情報レコードの名前。
credentials_alias_id	資格情報エイリアスレコードの sys_id。
credentials_alias_name	資格情報エイリアスの名前。
proxy_agent_id	このチェックを実行するエージェントプロキシの一意の ID。この値は、Agent Client Collector [sn_agent_cmdb_ci_agent] テーブルの [Agent ID] 列にリストされます。

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 125. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 126. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 127. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
500	テスト要求の構築中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
result_id	テスト結果レコードの sys_id。

Agent Client Collector - POST /agents/update/check/{check_id}

選択したポリシーチェックを更新します。

ポリシーのサンドボックスコピーのプロパティを取得するには、GET /agents/policy/sandbox_from_published/{policy_id} を使用します。

URL 形式

/api/sn_agent/agents/update/check/{check_id}

サポートされている要求パラメーター

表 : 128. パスパラメーター
名前	説明
check_id	チェックインスタンス [sn_agent_check] テーブル内のポリシーチェックのサンドボックスコピーの sys_id。データタイプ：文字列

表 : 129. クエリパラメーター
名前	説明
なし

表 : 130. 要求本文パラメーター (JSON)
名前	説明
active	ポリシーチェックがアクティブかどうかを示すフラグ。有効な値： true：ポリシーチェックはアクティブです。 false：ポリシーチェックはアクティブではありません。データタイプ：ブール
auto_generate	command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。有効な値： true：command プロパティにアクティブなパラメーター値を自動的に入力します。 false:コマンドは自動的に生成されません。データタイプ：ブーリアン
check_type	監視オプションを指定するチェックタイプ。可能な値： Discovery：エージェントに関連する CI を検索するチェック。 Events：チェックの結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
command	エージェントクライアントコレクターが実行するコマンド。テンプレートまたは監視対象 CI から取得されたパラメーター。注: auto_generate が true の場合、このプロパティには parameters オブジェクトにリストされているアクティブなパラメーターのプリフィックスとフラグが自動的に入力されます。データタイプ：文字列
command_prefix	auto_generate プロパティが true の場合、このコマンドが自動生成に使用されます。プリフィックスは、スクリプト名など、静的な (変化しない) コマンドの部分で構成されます。データタイプ：文字列
event_status_change_threshold	新しいイベントが送信される前にチェックの応答ステータスが発生する必要がある連続回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [OK] から [エラー] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、[エラー] ステータスの新しいイベントが生成されます。データタイプ：数値
event_status_repair_threshold	前のイベントをクローズするためにチェックの応答ステータスを連続して改善する必要がある回数。設定されていない場合は null を返します。たとえば、この値が 3 である場合、応答ステータスが [エラー] から [OK] に変化したチェックについて、そのステータス変化が 3 回連続して発生した後に、前のイベントがクローズされて [OK] ステータスの新しいイベントが生成されます。データタイプ：数値
interval	チェックの実行間隔を秒単位で待機します。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。データタイプ：数値
name	チェックの名前。データタイプ：文字列
timeout	出力が返されないときにチェックの実行が停止するまでの時間 (秒)。たとえば、値 60 は、チェックを実行して値が返されないまま 60 秒経過したときに実行が停止することを意味します。データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 131. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 132. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 133. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーチェックのイベント変更および修理プロパティを更新する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check/<check_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"event_status_change_threshold\" : \"2\",
    \"event_status_repair_threshold\" : \"1\"
}" \
--user 'username':'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - POST /agents/update/check_def_params/{check_def_param_id}

指定されたチェックパラメーターの 1 つ以上のフィールド値を変更できるようにします。

URL 形式

/api/sn_agent/agents/update/check_def_params/{check_def_param_id}

サポートされている要求パラメーター

表 : 134. パスパラメーター
名前	説明
check_def_param_id	チェックパラメーターのSys_id。データタイプ：文字列テーブル: チェックパラメーター定義 [sn_agent_check_param_def]

表 : 135. クエリパラメーター
名前	説明
なし

表 : 136. 要求本文パラメーター (JSON)
名前	説明
active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブーリアン
default_value	このチェックパラメーターのデフォルト値を指定します。データタイプ：文字列
mandatory	チェックパラメーターが必須かどうかを示すフラグ。有効な値： true：チェックパラメーターは必須です。 false：チェックパラメーターはオプションです。データタイプ：ブーリアン
name	チェックパラメーターの名前。データタイプ：文字列

注:

チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 137. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 138. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 139. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
404	指定された sys_id のチェックパラメーターが見つかりませんでした。
500	チェックパラメーターの更新中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
なし	成功またはエラーメッセージ。

cURL 要求

次の例は、チェックパラメーターを有効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_params/02d89bb01b307490f271ea42b24bcb63" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

出力：

"message": "Check Definition Parameter Updated Successfully"

Agent Client Collector - POST /agents/update/check_def_secure_params/{check_def_secure_param_id}

指定されたチェックセキュアパラメーターの 1 つ以上のフィールド値を変更できるようにします。

URL 形式

/api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id}

サポートされている要求パラメーター

表 : 140. パスパラメーター
名前	説明
check_def_secure_param_id	セキュアなパラメーターのSys_id。データタイプ：文字列表: チェックセキュアなパラメーター定義 [sn_agent_check_secure_param_def]

表 : 141. クエリパラメーター
名前	説明
なし

表 : 142. 要求本文パラメーター (JSON)
名前	説明
active	セキュアパラメーターがアクティブかどうかを示すフラグ。有効な値： true：セキュアパラメーターはアクティブです。 false：セキュアパラメーターは非アクティブです。データタイプ：ブーリアン
name	セキュアパラメーターの名前。データタイプ：文字列
order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 143. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 144. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 145. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
404	指定された sys_id のチェックセキュアなパラメーターが見つかりませんでした。
500	チェックセキュアなパラメーターの更新中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
なし	成功またはエラーメッセージ。

cURL 要求

次の例は、チェックセキュアなパラメーターを有効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_secure_params/2d30a066dba530106f4810284b9619c1" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

出力：

"message": "Check Definition Secure Parameter Updated Successfully"

Agent Client Collector - POST /agents/update/check_defs/{check_def_id}

指定されたチェック定義の 1 つ以上のフィールド値を変更できるようにします。

URL 形式

/api/sn_agent/agents/update/check_defs/{check_def_id}

サポートされている要求パラメーター

表 : 146. パスパラメーター
名前	説明
check_def_id	チェック定義 [sn_agent_check_def] テーブルにリストされたチェック定義の sys_id。データタイプ：文字列

表 : 147. クエリパラメーター
名前	説明
なし

表 : 148. 要求本文パラメーター (JSON)
名前	説明
active	このチェック定義がアクティブかどうかを示します。有効な値： 0：このチェック定義は非アクティブです。 1：このチェック定義はアクティブです。データタイプ：数値
background	このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始するチェックであり、エージェントが実行を終了するまで待機しません。有効な値： true：このチェック定義はバックグラウンドチェックです。 false：このチェック定義はバックグラウンドチェックではありません。データタイプ：ブール
check_group	このチェック定義に指定されたグループ。
check_type	チェックのタイプ。可能な値： Events：チェック結果が Event Management イベントに変換されます。 Metrics：チェック結果からの値が測定基準に変換されます。データタイプ：文字列
command	エージェントクライアントコレクターが実行するコマンド。データタイプ：文字列
name	チェックの名前。データタイプ：文字列
params	パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 `"params": { "<parameter name>": "String" }` データタイプ：オブジェクト
プラグイン	のリストエージェントクライアントコレクタープラグインこのチェックに関連付けられています。データタイプ：アレイ
proxy_valid	チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。有効な値： true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。データタイプ：ブーリアン
クエリ	table プロパティで指定されたテーブルから GlideRecord を取得するためのエンコードされたクエリ。データタイプ：文字列
table	このチェックの cmdb_ci テーブルの名前。データタイプ：文字列
timeout	タイムアウト (秒)。データタイプ：数値

注:

チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 149. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 150. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 151. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
404	指定された sys_id のチェック定義が見つかりませんでした。
500	チェック定義の更新中にエラーが発生しました。

応答本文のパラメーター (JSON)


名前	説明
なし	成功またはエラーメッセージ。

cURL 要求

次の例は、チェック定義を無効にする方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check_defs/99e12466dba530106f4810284b961976" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"false\"}" \
--user 'username':'password'

出力：

"message": "Check Definition Updated Successfully"

Agent Client Collector - POST /agents/update/check_param/{param_id}

選択したポリシーチェックパラメーターを更新します。

ポリシーのサンドボックスコピーのプロパティを取得するには、GET /agents/policy/sandbox_from_published/{policy_id} を使用します。

URL 形式

/api/sn_agent/agents/update/check_param/{param_id}

サポートされている要求パラメーター

表 : 152. パスパラメーター
名前	説明
param_id	ポリシーチェックパラメーターサンドボックスのコピー Sys_id。データタイプ：文字列テーブル:チェックパラメーター [sn_agent_check_param]

表 : 153. クエリパラメーター
名前	説明
なし

表 : 154. 要求本文パラメーター (JSON)
名前	説明
active	チェックパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックパラメーターはアクティブです。 false：チェックパラメーターは非アクティブです。データタイプ：ブール
フラグ
mandatory	チェックが必須かどうかを示すフラグ。有効な値： true：このチェックは必須です。 false：このチェックはオプションです。データタイプ：ブール
name	パラメーターの名前です。データタイプ：文字列
value	パラメーターの値。データタイプ：文字列
value_required	value プロパティによって提供される情報が必須かどうかを示すフラグ。有効な値： true：value プロパティは必須です。 false：value プロパティは null かまたは必須ではありません。データタイプ：ブール

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 155. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 156. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 157. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーチェックパラメーターのいくつかのプロパティを更新する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"flag\" : \"-d\",
   \"mandatory\" : \"true\",
   \"name\" : \"scheme2\",
   \"value\" : \"120\",
   \"value_required\" : \"false\"
}" \
--user 'username':'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - POST /agents/update/check_secure_param/{param_id}

選択したポリシーのチェックセキュアなパラメーターを更新します。

ポリシーのサンドボックスコピーのプロパティを取得するには、GET /agents/policy/sandbox_from_published/{policy_id} を使用します。

URL 形式

/api/sn_agent/agents/update/check_secure_param/{param_id}

サポートされている要求パラメーター

表 : 158. パスパラメーター
名前	説明
param_id	ポリシーチェックのセキュアなパラメーターサンドボックスのコピー Sys_id。データタイプ：文字列表: チェックセキュアなパラメーター [sn_agent_check_secure_param]

表 : 159. クエリパラメーター
名前	説明
なし

表 : 160. 要求本文パラメーター (JSON)
名前	説明
active	チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。有効な値： true：チェックのセキュアなパラメーターはアクティブです。 false：チェックのセキュアなパラメーターは非アクティブです。データタイプ：ブール
name	セキュアパラメーターの名前。データタイプ：文字列
order	パラメーターがチェックコマンド/スクリプトに送信される順序。データタイプ：数値

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 161. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 162. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 163. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーのチェックセキュアなパラメーターのプロパティを更新する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\" : \"new name\",
   \"order\" : \"2\"
}" \
--user 'username':'password'

出力：

{
  "message": "Operation was successful"
}

Agent Client Collector - GET /agents/policy/activate/{policy_id}

ポリシーのサンドボックスコピーを更新します。

ポリシーのサンドボックスコピーのプロパティを取得するには、GET /agents/policy/sandbox_from_published/{policy_id} を使用します。

URL 形式

/api/sn_agent/agents/update/policy/{policy_id}

サポートされている要求パラメーター

表 : 164. パスパラメーター
名前	説明
policy_id	ポリシーサンドボックスのコピーのSys_id。データタイプ：文字列テーブル:ポリシー [sn_agent_policy]

表 : 165. クエリパラメーター
名前	説明
なし

表 : 166. 要求本文パラメーター (JSON)
名前	説明
cred_alias	認証情報名。データタイプ：文字列テーブル:認証情報 [discovery_credentials]
credential_alias	認証情報エイリアスのSys_id。データタイプ：文字列テーブル:接続および資格情報エイリアス [sys_alias]
filter	指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。データタイプ：文字列
interval	ポリシーチェック間の待機時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。データタイプ：数値
monitored_ci_group	ポリシーに関連付けられた CMDB グループの名前。このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。データタイプ：文字列テーブル:CMDB グループ [cmdb_group]
monitored_ci_script	CI を監視するためのスクリプト。このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。データタイプ：文字列
monitored_ci_type_filter	CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。有効な値： true：チェックグループによるフィルタリングが有効です。 false：チェックグループによるフィルタリングが無効です。データタイプ：ブール
monitored_ci_type_group	CMDB グループタイプによる監視が有効かどうかを示すフラグ。有効な値： true：CMDB グループタイプは有効です。 false：CMDB グループタイプは無効です。データタイプ：ブール
monitored_ci_type_script	CI を監視するためのスクリプトが有効かどうかを示すフラグ。有効な値： true：CI を監視するためのスクリプトは有効です。 false：CI を監視するためのスクリプトは無効です。データタイプ：ブール
name	ポリシーの名前。データタイプ：文字列
table	ポリシーの監視対象 CI タイプフィールド。このフィールドは、monitored_ci_type_filter が true の場合にのみ適用されます。データタイプ：文字列

ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 167. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。application/json のみをサポートします。

表 : 168. 応答ヘッダー
ヘッダー	説明
なし

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 169. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
403	ユーザーに agent_client_collector_admin ロールがありません。
404	指定された sys_id のレコードが見つかりません。
500	内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

応答本文のパラメーター (JSON)


名前	説明
message	操作の成功または失敗の結果を含むメッセージ。データタイプ：文字列

cURL 要求

次の例は、ポリシーの名前およびフィルタープロパティ/フィールドを更新する方法を示しています。

curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/<policy_sys_id>" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\" : \"new policy name\",
  \"filter\" : \"operational_status=1\"
}" \
--user 'username':'password'

出力：

{
  "message": "Operation was successful"
}