--- sourceDocument: Xanadu API リファレンス sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference Release : - xanadu ft:locale : - ja-JP ft:publication_title : - Xanadu API リファレンス ft:clusterId : - crapiref bundleId : - crapiref workflow : - Creator --- # Agent Client Collector API # Agent Client Collector API {#ariaid-title1} * リリースバージョン: Xanadu * * 更新日 2024年08月01日 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：125分 Agent Client Collector API は、利用可能なエージェントのアクションと管理ポリシーを管理するためのエンドポイントを提供します。 この API は、エージェントクライアントコレクター Framework (sn_agent) ストアアプリケーションを必要とし、`sn_agent` 名前空間内で提供されます。この API のエンドポイントには agent_client_collector_admin ロールが必要です。詳細については、「 [エージェントクライアントコレクター](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。 エージェント管理エンドポイント : * 1 つ以上のエージェントの詳細情報を取得します。これらのエンドポイントには、agent_client_collector_user ロールを持つユーザーもアクセスできます。 * [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-agent_id "指定されたエージェントの情報を取得します。") * [GET /agents/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-list "関連情報を含むエージェントのリストを取得します。") {#agnt_clnt_cll-api__ul_tsy_mkq_dpb} * 要求を送信してエージェントログを取得し、要求の進捗状況に関する情報を取得します。 * [GET /agents/{agent_id}/log](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-log "アライブ/稼働ステータスの指定されたエージェントのログを要求します。") * [GET /agents/log/{request_id}/](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-log-request_id "ログ取得要求のステータスを確認します。") {#agnt_clnt_cll-api__ul_rpm_4kq_dpb} * エージェントデータ収集を無効または有効にします。 * [GET /agents/{agent_id}/data/off](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-data-off "ステータスが稼働/アライブの指定エージェントでデータ収集を無効にします。") * [GET /agents/{agent_id}/data/on](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-data-on "ステータスが稼働/アライブの指定エージェントでデータ収集を有効にします。") {#agnt_clnt_cll-api__ul_z43_gkq_dpb} * [GET /agents/{agent_id}/restart](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-restart "アライブ/稼働ステータスの指定されたエージェントを再起動します。") を使用してエージェントを再起動します。 * [GET /agents/{agent_id}/discovery](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-discovery "検出チェックを実行して、エージェントに関連する CI を特定します。指定されたエージェントは、アライブ/稼働ステータスである必要があります。") を使用してエージェントで検出を実行します。 {#agnt_clnt_cll-api__ul_mlz_ckq_dpb} スクリプトインクルードで同様のタスクを実行する方法については、「 [AccAgentsAPI](https://developer.servicenow.com/go_to_api.do?ID=AccAgentsAPIAPIScoped&v=utah)」を参照してください。 ポリシー管理とワークフロー : ポリシー管理 API を使用して、詳細の表示、ポリシーの有効化/無効化、ポリシーの更新、ポリシーの公開を行います。 : ポリシーを更新するには： 1. [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policies-list "ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。") を使用してポリシーと詳細のリストを取得します。このエンドポイントには agent_client_collector_user ロールが必要です。 * 「ドラフト」ステータスのポリシーを更新するには、更新エンドポイントのポリシーリストから取得した sys_id を使用します。 * 「公開済み」または「公開済み\*」ステータスのポリシーを更新するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用して、編集可能なサンドボックスのコピーを取得します。この応答の sys_id を使用して、更新エンドポイントを使用してプロパティを変更します。 {#agnt_clnt_cll-api__ul_mtj_whk_fpb} 2. 更新エンドポイントを使用してポリシーの詳細を変更します。 * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-policy "ポリシーのサンドボックスコピーを更新します。") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check-id "選択したポリシーチェックを更新します。") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_param "選択したポリシーチェックパラメーターを更新します。") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_secure "選択したポリシーのチェックセキュアなパラメーターを更新します。") {#agnt_clnt_cll-api__ul_mp4_xjk_fpb} 3. [GET /agents/policy/publish/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-publish "ドラフトポリシーを公開します。") を使用してポリシーを公開します。 {#agnt_clnt_cll-api__ol_rmk_chk_fpb} : 公開されると、ポリシーは「アクティブ」になります。この API には、公開されたポリシーを有効または無効にするためのエンドポイントも含まれています。 * [GET /agents/policy/activate/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-act "公開されたポリシーをアクティブにします。") * [GET /agents/policy/deactivate/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-deact "公開されたポリシーを無効にします。") {#agnt_clnt_cll-api__ul_glm_flk_fpb} ## Agent Client Collector - GET /agents/{agent_id} {#ariaid-title2} 指定されたエージェントの情報を取得します。 ### URL 形式 /api/sn_agent/agents/{agent_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-agent_id__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 1. パスパラメーター] {#agnt_clnt_cll-GET-agent_id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 2. クエリパラメーター] {#agnt_clnt_cll-GET-agent_id__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 3. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-agent_id__entry__14}{#agnt_clnt_cll-GET-agent_id__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 4. 要求ヘッダー] {#agnt_clnt_cll-GET-agent_id__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 5. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-agent_id__entry__22}{#agnt_clnt_cll-GET-agent_id__entry-200-status-code}{#agnt_clnt_cll-GET-agent_id__agntCC-desc-403-user} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_user ロールがありません。 | | 404 | 指定された ID のエージェントが見つかりません。 | [表 : 6. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-agent_id__entry__30}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-agent_id__accAgents-parm-agent-obj-version-entry} | 名前 | 説明 | |-|-| | \ | エージェントの詳細情報を含む 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 の消費量が多いため、チェックが自動的に無効になりました {#agnt_clnt_cll-GET-agent_id__ul_w4n_53p_bpb} データタイプ：数値 | | ip_address | エージェントの IP アドレス。 データタイプ：文字列 | | is_duplicate | このエージェントが別のエージェントの複製であるかどうかを示すフラグ。指定されたホストには 1 つのエージェントのみが存在している必要があります。 可能な値： * true：エージェントは、異なるエージェント ID を持つアライブ/稼動エージェントと同じホストを持っています。重複をオフにするかアンインストールします * false：このエージェントには、アライブ/稼働ステータスの重複はありません。 {#agnt_clnt_cll-GET-agent_id__ul_b34_ffl_bpb} データタイプ：ブール | | is_restart_enabled | 再起動が有効かどうかを示すフラグ。エージェントの再起動は構成できません。OS と、エージェントが実行されている OS のバージョンによって異なります。 可能な値： * true：このエージェントの再起動が有効です。 * false：このエージェントの再起動が無効です。 {#agnt_clnt_cll-GET-agent_id__ul_bvp_dfl_bpb} データタイプ：ブール | | name | エージェントの名前。 データタイプ：文字列 | | number_of_running_checks | エージェントの実行がスケジュールされているチェックの数。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。 データタイプ：数値 | | status | エージェントのステータス。 可能な値： * 0：アライブ/稼動 -- エージェントはアクティブです。 * 1：警告 - エージェントは過去数分間にキープアライブメッセージを受信していません。 * 2：停止 - エージェントが長期間にわたってキープアライブメッセージを受信していません。 * 3：再起動中 - エージェントを再起動しています。 {#agnt_clnt_cll-GET-agent_id__ul_adg_ffp_bpb} データタイプ：数値 | | up_since | エージェントのステータスがアライブ/稼働になってからの UTC 時間。値は [GlideDateTime](https://servicenow-prod.fluidtopics.net/xWri1nmJyGLw7m~IPzfcdg#c_GlideDateTimeScoped "スコープ指定された GlideDateTime クラスは、GlideDateTime オブジェクトに対する操作を実行するためのメソッドを提供します。") 形式です。 データタイプ：文字列 | | version | エージェントが実行している エージェントクライアントコレクター のバージョン。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、エージェントの詳細を取得する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/" \ --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 {#ariaid-title3} ステータスが稼働/アライブの指定エージェントでデータ収集を無効にします。 エージェントのデータ収集がオンかオフかを判断するには、GET /agents/{agent_id} エンドポイントを実行します。 ### URL 形式 {#agnt_clnt_cll-GET-data-off__section_bbq_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/off ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-data-off__section_cbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 7. パスパラメーター] {#agnt_clnt_cll-GET-data-off__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 8. クエリパラメーター] {#agnt_clnt_cll-GET-data-off__table_ebq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 9. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-data-off__table_fbq_zyc_z4b} ### ヘッダー {#agnt_clnt_cll-GET-data-off__section_gbq_zyc_z4b} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-off__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 10. 要求ヘッダー] {#agnt_clnt_cll-GET-data-off__table_hbq_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 11. 応答ヘッダー] {#agnt_clnt_cll-GET-data-off__table_ibq_zyc_z4b} ### ステータスコード {#agnt_clnt_cll-GET-data-off__section_jbq_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-off__entry-200-status-code}{#agnt_clnt_cll-GET-data-off__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | エージェントが見つからないか、稼働中/アライブ状態ではありません。 | [表 : 12. ステータスコード] {#agnt_clnt_cll-GET-data-off__table_epg_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-data-off__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-data-off__table_owl_zyc_z4b} ### cURL 要求 {#agnt_clnt_cll-GET-data-off__example_nbq_zyc_z4b} 次の例は、エージェントのデータ収集を無効にする方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents//data/off" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 出力： { "message": "Data Collection Disabled For Agent With ID: " } ## Agent Client Collector - GET /agents/{agent_id}/data/on {#ariaid-title4} ステータスが稼働/アライブの指定エージェントでデータ収集を有効にします。 エージェントのデータ収集がオンかオフかを判断するには、GET /agents/{agent_id} エンドポイントを実行します。 ### URL 形式 {#agnt_clnt_cll-GET-data-on__section_dwl_zyc_z4b} /api/sn_agent/agents/{agent_id}/data/on ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-data-on__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 13. パスパラメーター] {#agnt_clnt_cll-GET-data-on__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 14. クエリパラメーター] {#agnt_clnt_cll-GET-data-on__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 15. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-data-on__table_hwl_zyc_z4b} ### ヘッダー {#agnt_clnt_cll-GET-data-on__section_iwl_zyc_z4b} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-data-on__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 16. 要求ヘッダー] {#agnt_clnt_cll-GET-data-on__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 17. 応答ヘッダー] {#agnt_clnt_cll-GET-data-on__table_kwl_zyc_z4b} ### ステータスコード {#agnt_clnt_cll-GET-data-on__section_lwl_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-data-on__entry-200-status-code}{#agnt_clnt_cll-GET-data-on__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | エージェントが見つからないか、稼働中/アライブ状態ではありません。 | [表 : 18. ステータスコード] {#agnt_clnt_cll-GET-data-on__table_y2n_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-data-on__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-data-on__table_owl_zyc_z4b} ### cURL 要求 {#agnt_clnt_cll-GET-data-on__example_pwl_zyc_z4b} 次の例は、エージェントのデータ収集を有効にする方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents//data/on" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 出力： { "message": "Data Collection Enabled For Agent With ID: " } ## Agent Client Collector - GET /agents/{agent_id}/discovery {#ariaid-title5} 検出チェックを実行して、エージェントに関連する CI を特定します。指定されたエージェントは、アライブ/稼働ステータスである必要があります。 ### URL 形式 /api/sn_agent/agents/{agent_id}/discovery ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-discovery__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 19. パスパラメーター] {#agnt_clnt_cll-GET-discovery__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 20. クエリパラメーター] {#agnt_clnt_cll-GET-discovery__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 21. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-discovery__table_hwl_zyc_z4b} ### ヘッダー {#agnt_clnt_cll-GET-discovery__section_iwl_zyc_z4b} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-discovery__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 22. 要求ヘッダー] {#agnt_clnt_cll-GET-discovery__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 23. 応答ヘッダー] {#agnt_clnt_cll-GET-discovery__table_kwl_zyc_z4b} ### ステータスコード {#agnt_clnt_cll-GET-discovery__section_lwl_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-discovery__entry-200-status-code}{#agnt_clnt_cll-GET-discovery__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | エージェントが見つからないか、稼働中/アライブ状態ではありません。 | [表 : 24. ステータスコード] {#agnt_clnt_cll-GET-discovery__table_y2n_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-discovery__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b} ### cURL 要求 次の例は、アライブ/稼働ステータスのエージェントで検出を実行する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents//discovery" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 出力： { "message": "Running Discovery For Agent With ID: " } ## Agent Client Collector - GET /agents/check_defs/{check_def_id} {#ariaid-title6} 詳細を含む指定されたチェック定義を取得します。 ### URL 形式 /api/sn_agent/agents/check_defs/{check_def_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-check_defs-id__entry__2} | 名前 | 説明 | |-|-| | check_def_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 データタイプ：文字列 | [表 : 25. パスパラメーター] {#agnt_clnt_cll-GET-check_defs-id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 26. クエリパラメーター] {#agnt_clnt_cll-GET-check_defs-id__entry__10} | 名前 | 説明 | |-|-| | X-Include-Check-Params | 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。 有効な値： * true：チェックパラメーターの詳細を返します。 * false：チェックパラメーターの詳細を返しません。 {#agnt_clnt_cll-GET-check_defs-id__ul_pv3_gqc_wqb} データタイプ：ブーリアン デフォルト値：False | [表 : 27. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-check_defs-id__entry__14}{#agnt_clnt_cll-GET-check_defs-id__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 28. 要求ヘッダー] {#agnt_clnt_cll-GET-check_defs-id__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 29. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-check_defs-id__entry__22}{#agnt_clnt_cll-GET-check_defs-id__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 404 | 指定された sys_id のチェック定義が見つかりませんでした。 | [表 : 30. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-check_defs-id__entry__28}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-id__accCkDf-timeout-desc-ph} | プロパティ | 説明 | |-|-| | 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：このチェック定義はバックグラウンドチェックではありません。 {#agnt_clnt_cll-GET-check_defs-id__ul_ypb_5ps_5qb} データタイプ：ブール | | check_group | このチェック定義に指定されたグループ。 データタイプ：文字列 | | check_type | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-GET-check_defs-id__ul_gtr_kfb_wqb} データタイプ：文字列 | | command | エージェントクライアントコレクター が実行するコマンド。 データタイプ：文字列 | | error | エラーがある場合のメッセージ。それ以外の場合は Null です。 データタイプ：文字列 | | name | チェックの名前。 データタイプ：文字列 | | params | チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-p-code} データタイプ：アレイ | | params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-check_defs-id__ul_pnb_jyc_wqb} データタイプ：ブール | | params.default_value | このチェックパラメーターのデフォルト値を指定します。 データタイプ：文字列 | | params.mandatory | チェックパラメーターが必須かどうかを示すフラグ。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#agnt_clnt_cll-GET-check_defs-id__ul_wtg_2zc_wqb} データタイプ：ブール | | params.name | チェックパラメーターの名前。 データタイプ：文字列 | | params.sys_id | チェックセキュアパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 データタイプ：文字列 | | plugins | このチェックに関連付けられている [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) のリスト。 データタイプ：アレイ | | proxy_valid | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#agnt_clnt_cll-GET-check_defs-id__ul_wbf_qps_5qb} データタイプ：ブール | | secure_params | このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-id__accCkDf-sp-code} データタイプ：アレイ | | secure_params.active | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-check_defs-id__ul_g1b_3vc_wqb} データタイプ：ブール | | 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 {#ariaid-title7} 詳細を含むチェック定義のリストを取得します。 ### URL 形式 /api/sn_agent/agents/check_defs/list ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-check_defs-list__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 31. パスパラメーター] {#agnt_clnt_cll-GET-check_defs-list__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 32. クエリパラメータ] {#agnt_clnt_cll-GET-check_defs-list__entry__10} | 名前 | 説明 | |-|-| | X-Enc-Query | チェック定義の結果リストをフィルタリングするための [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) 。システム内のチェック定義のフィルタリングされていないリストには null を使用します。 データタイプ：文字列 | | X-Include-Check-Params | 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。 有効な値： * true：チェックパラメーターの詳細を返します。 * false：チェックパラメーターの詳細を返しません。 {#agnt_clnt_cll-GET-check_defs-list__ul_pv3_gqc_wqb} データタイプ：ブーリアン デフォルト値：False | | X-Limit | 返されるレコードの数を制限します。デフォルト値を使用するには、null に設定します。 データタイプ：数値 デフォルト：20,000 | [表 : 33. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-check_defs-list__entry__18}{#agnt_clnt_cll-GET-check_defs-list__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 34. 要求ヘッダー] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 35. 応答ヘッダー] {#agnt_clnt_cll-GET-check_defs-list__table_ufx_wwq_wqb} ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-check_defs-list__entry__26}{#agnt_clnt_cll-GET-check_defs-list__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | [表 : 36. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-check_defs-list__entry__30}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-background-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkGrp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-chkTyp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-command-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-default-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-mando-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-plugins-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-proxy-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-active-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-name-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-order-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-id-desc-ph}{#agnt_clnt_cll-GET-check_defs-list__accCkDf-timeout-desc-ph} | 名前 | 説明 | |-|-| | チェック定義 | 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：このチェック定義はバックグラウンドチェックではありません。 {#agnt_clnt_cll-GET-check_defs-list__ul_ypb_5ps_5qb} データタイプ：ブール | | check_group | このチェック定義に指定されたグループ。 データタイプ：文字列 | | check_type | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-GET-check_defs-list__ul_gtr_kfb_wqb} データタイプ：文字列 | | command | エージェントクライアントコレクター が実行するコマンド。 データタイプ：文字列 | | name | チェックの名前。 データタイプ：文字列 | | params | チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-p-code} データタイプ：アレイ | | params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-check_defs-list__ul_pnb_jyc_wqb} データタイプ：ブール | | params.default_value | このチェックパラメーターのデフォルト値を指定します。 データタイプ：文字列 | | params.mandatory | チェックパラメーターが必須かどうかを示すフラグ。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#agnt_clnt_cll-GET-check_defs-list__ul_wtg_2zc_wqb} データタイプ：ブール | | params.name | チェックパラメーターの名前。 データタイプ：文字列 | | params.sys_id | チェックセキュアパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 データタイプ：文字列 | | プラグイン | このチェックに関連付けられている [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) のリスト。 データタイプ：アレイ | | proxy_valid | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#agnt_clnt_cll-GET-check_defs-list__ul_wbf_qps_5qb} データタイプ：ブール | | secure_params | このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#agnt_clnt_cll-GET-check_defs-list__accCkDf-sp-code} データタイプ：アレイ | | secure_params.active | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-check_defs-list__ul_g1b_3vc_wqb} データタイプ：ブール | | 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} {#ariaid-title8} バックグラウンドチェックを停止します。 バックグラウンドチェックを開始するには、POST /agents/check_defs/{check_def_id}/run API を使用します。 ### URL 形式 /api/sn_agent/agents/exec/background/stop/{request_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__2} | 名前 | 説明 | |-|-| | request_id | POST /agents/check_defs/{check_def_id}/run API を実行して生成されたバックグラウンドチェック要求の ID。 | [表 : 37. パスパラメーター] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 38. クエリパラメーター] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 39. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__14}{#agnt_clnt_cll-GET-exec-bkgrd-stop__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 40. 要求ヘッダー] {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 41. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__22}{#agnt_clnt_cll-GET-exec-bkgrd-stop__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 404 | 指定された ID の要求が見つかりません。 | [表 : 42. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-exec-bkgrd-stop__entry__28} | 名前 | 説明 | |-|-| | なし | | [ ] ### 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} {#ariaid-title9} 指定された ID の要求のステータスを取得します。 ### URL 形式 /api/sn_agent/agents/exec/run/{request_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb__entry__2} | 名前 | 説明 | |-|-| | request_id | POST /agents/check_defs/{check_def_id}/run API を実行して生成されたバックグラウンドチェック要求の ID。 | [表 : 43. パスパラメーター] {#agnt_clnt_cll-GET-exec-run__table_vmf_44q_wqb} {#agnt_clnt_cll-GET-exec-run__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 44. クエリパラメーター] {#agnt_clnt_cll-GET-exec-run__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 45. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-run__entry__14}{#agnt_clnt_cll-GET-exec-run__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 46. 要求ヘッダー] {#agnt_clnt_cll-GET-exec-run__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 47. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb__entry__2}{#agnt_clnt_cll-GET-exec-run__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 202 | 要求が進行中であることを示す、指定された ID のメッセージ。 | | 400 | 要求本文で指定された引数にエラーがあります。 | | 404 | 指定された ID の要求が見つかりません。 | | 408 | 指定された ID の要求の実行タイムアウト。 | | 500 | 指定された ID のステータスまたは要求のチェック中にエラーが発生しました。 | [表 : 48. ステータスコード] {#agnt_clnt_cll-GET-exec-run__table_zdx_xmq_wqb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-exec-run__entry__36} | 名前 | 説明 | |-|-| | status | 要求ステータス。 可能な値： * done - チェックに成功しました。 * failure -- チェックに失敗しました。詳細はエラーメッセージを参照してください。 * mid_flow -- 要求の出力は MID サーバーによって処理されています。 * processing -- チェックが進行中です。 * timeout -- チェックの処理が runCheckForCis() メソッドで設定された時間制限を超えました。 {#agnt_clnt_cll-GET-exec-run__ul_edm_1rr_5qb} データタイプ：文字列 | | err_msg | エラーメッセージ (存在する場合)。 可能な値： * 関連する CI のエージェントが見つかりません。 * 指定された ID のバックグラウンドチェック要求はありません。 * 指定された ID の要求はありません。 * 指定された ID のテスト結果はありません。 * 要求タイムアウト。 {#agnt_clnt_cll-GET-exec-run__ul_qcf_zcq_5qb} データタイプ：文字列 | [ ] ### 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} {#ariaid-title10} 指定されたテスト結果のテストチェックステータスを取得します。 ### URL 形式 /api/sn_agent/agents/exec/test/{test_result_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-exec-test-result__entry__2} | 名前 | 説明 | |-|-| | test_result_id | テストチェック要求の作成によって生成されるテスト結果 ID。 | [表 : 49. パスパラメーター] {#agnt_clnt_cll-GET-exec-test-result__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 50. クエリパラメーター] {#agnt_clnt_cll-GET-exec-test-result__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 51. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-test-result__entry__14}{#agnt_clnt_cll-GET-exec-test-result__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 52. 要求ヘッダー] {#agnt_clnt_cll-GET-exec-test-result__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 53. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-exec-test-result__entry__22}{#agnt_clnt_cll-GET-exec-test-result__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 202 | 要求が進行中であることを示す、指定された ID のメッセージ。 | | 404 | 指定された ID の要求が見つかりません。 | | 408 | 指定された ID の要求の実行タイムアウト。 | | 500 | 指定された ID の要求のステータスのチェック中にエラーが発生しました。 | [表 : 54. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-exec-test-result__entry__34} | プロパティ | 説明 | |-|-| | status | テスト結果のステータス。 可能な値： * 0：処理待ち * 1：処理中 * 2：完了 * 3：指定された ID のテスト結果なし {#agnt_clnt_cll-GET-exec-test-result__ul_yyq_4bq_5qb} データタイプ：文字列 | | 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 {#ariaid-title11} 関連情報を含むエージェントのリストを取得します。 ### URL 形式 /api/sn_agent/agents/list ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-list__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 55. パスパラメーター] {#agnt_clnt_cll-GET-list__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 56. クエリパラメータ] {#agnt_clnt_cll-GET-list__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 57. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-list__entry__14}{#agnt_clnt_cll-GET-list__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | X-Enc-Query | 標準の Glide 形式の Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルのエンコードクエリ。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 | | X-Limit | 結果をエージェントの最大数に制限します。必要ない場合は、両方に null または undefined を使用します。デフォルト/最大：20,000 データタイプ：数値 | [表 : 58. 要求ヘッダー] {#agnt_clnt_cll-GET-list__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 59. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-list__table_vxl_353_dpb__entry__2}{#agnt_clnt_cll-GET-list__entry-200-status-code}{#agnt_clnt_cll-GET-list__agntCC-desc-403-user} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_user ロールがありません。 | [表 : 60. ステータスコード] {#agnt_clnt_cll-GET-list__table_vxl_353_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-list__entry__32}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-id-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dataCollect-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-ip-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-dup-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-restart-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-name-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-numChecks-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-status-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-up-entry}{#agnt_clnt_cll-GET-list__accAgents-parm-agent-obj-version-entry} | プロパティ | 説明 | |-|-| | \ | エージェントの詳細情報を含む 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 の消費量が多いため、チェックが自動的に無効になりました {#agnt_clnt_cll-GET-list__ul_w4n_53p_bpb} データタイプ：数値 | | ip_address | エージェントの IP アドレス。 データタイプ：文字列 | | is_duplicate | このエージェントが別のエージェントの複製であるかどうかを示すフラグ。指定されたホストには 1 つのエージェントのみが存在している必要があります。 可能な値： * true：エージェントは、異なるエージェント ID を持つアライブ/稼動エージェントと同じホストを持っています。重複をオフにするかアンインストールします * false：このエージェントには、アライブ/稼働ステータスの重複はありません。 {#agnt_clnt_cll-GET-list__ul_b34_ffl_bpb} データタイプ：ブール | | is_restart_enabled | 再起動が有効かどうかを示すフラグ。エージェントの再起動は構成できません。OS と、エージェントが実行されている OS のバージョンによって異なります。 可能な値： * true：このエージェントの再起動が有効です。 * false：このエージェントの再起動が無効です。 {#agnt_clnt_cll-GET-list__ul_bvp_dfl_bpb} データタイプ：ブール | | name | エージェントの名前。 データタイプ：文字列 | | number_of_running_checks | エージェントの実行がスケジュールされているチェックの数。これらのチェックは、このエージェントが実行されるようにスケジュールされたポリシーの一部です。 データタイプ：数値 | | status | エージェントのステータス。 可能な値： * 0：アライブ/稼動 -- エージェントはアクティブです。 * 1：警告 - エージェントは過去数分間にキープアライブメッセージを受信していません。 * 2：停止 - エージェントが長期間にわたってキープアライブメッセージを受信していません。 * 3：再起動中 - エージェントを再起動しています。 {#agnt_clnt_cll-GET-list__ul_adg_ffp_bpb} データタイプ：数値 | | up_since | エージェントのステータスがアライブ/稼働になってからの UTC 時間。値は [GlideDateTime](https://servicenow-prod.fluidtopics.net/xWri1nmJyGLw7m~IPzfcdg#c_GlideDateTimeScoped "スコープ指定された GlideDateTime クラスは、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 要求 {#agnt_clnt_cll-GET-list__example_es5_ycj_dpb} 次の例は、システム内のすべてのエージェントを一覧表示する方法を示しています。この例では、クエリと結果の最大数を使用していません。 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 {#ariaid-title12} アライブ/稼働ステータスの指定されたエージェントのログを要求します。 注: ログを取得してその進捗状況を確認するには、返された要求 ID を GET /agents/log/{request_id}/ エンドポイントに渡します。 ### URL 形式 {#agnt_clnt_cll-GET-log__section_kpf_zyc_z4b} /api/sn_agent/agents/{agent_id}/log ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-log__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 61. パスパラメーター] {#agnt_clnt_cll-GET-log__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 62. クエリパラメーター] {#agnt_clnt_cll-GET-log__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 63. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-log__table_hwl_zyc_z4b} ### ヘッダー {#agnt_clnt_cll-GET-log__section_iwl_zyc_z4b} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-log__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 64. 要求ヘッダー] {#agnt_clnt_cll-GET-log__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 65. 応答ヘッダー] {#agnt_clnt_cll-GET-log__table_kwl_zyc_z4b} ### ステータスコード {#agnt_clnt_cll-GET-log__section_lwl_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log__entry-200-status-code}{#agnt_clnt_cll-GET-log__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | エージェントが見つからないか、稼働中/アライブ状態ではありません。 | [表 : 66. ステータスコード] {#agnt_clnt_cll-GET-log__table_y2n_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-log__section_upf_zyc_z4b} {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | request_id | Agent Client Collector Requests \[sn_agent_request\] テーブル内の要求の sys_id。 この ID を使用して、GET /agents/log/{request_id}/ エンドポイントでログを取得してその進捗状況を確認できます。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-log__table_vpf_zyc_z4b} ### cURL 要求 次の例は、ログ要求 ID を取得する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents//log" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 出力： "request_id": "" ## Agent Client Collector - GET /agents/log/{request_id}/ {#ariaid-title13} ログ取得要求のステータスを確認します。 GET /api/sn_agent/agents/{agent_id}/log を使用して送信されたログ取得要求の変更を検出します。 ### URL 形式 /api/sn_agent/agents/log/{request_id}/ ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-log-request_id__entry__2} | 名前 | 説明 | |-|-| | request_id | Agent Client Collector Requests \[sn_agent_request\] テーブル内の要求の sys_id。 要求 ID について、GET /api/sn_agent/agents/{agent_id}/log を実行します。 データタイプ：文字列 | [表 : 67. パスパラメーター] {#agnt_clnt_cll-GET-log-request_id__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 68. クエリパラメーター] {#agnt_clnt_cll-GET-log-request_id__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 69. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-log-request_id__entry__14}{#agnt_clnt_cll-GET-log-request_id__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 70. 要求ヘッダー] {#agnt_clnt_cll-GET-log-request_id__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 71. 応答ヘッダー] ### ステータスコード {#agnt_clnt_cll-GET-log-request_id__section_lwl_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-log-request_id__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 要求ステータスが完了し、取得されたログの準備ができました。 | | 202 | 指定された ID のログ取得要求がまだ進行中です。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された ID のログ取得要求が見つかりません。 | | 408 | ログ取得要求はタイムアウトしました。 | | 500 | ログ取得要求でエラーが発生しました。 | [表 : 72. ステータスコード] {#agnt_clnt_cll-GET-log-request_id__table_y2n_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-log-request_id__entry__36} | プロパティ | 説明 | |-|-| | output | ステータスを説明する情報。 | [ ] ### cURL 要求 次の例は、要求 ID を使用してログ取得要求のステータスを取得する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/log/" \ --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 {#ariaid-title14} ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。 ### URL 形式 /api/sn_agent/agents/policies/list ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-policies-list__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 73. パスパラメーター] {#agnt_clnt_cll-GET-policies-list__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 74. クエリパラメータ] {#agnt_clnt_cll-GET-policies-list__entry__10} | 名前 | 説明 | |-|-| | なし | | [表 : 75. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb__entry__2}{#agnt_clnt_cll-GET-policies-list__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | | X-Enc-Query | オプション。 標準の Glide 形式のエンコードされたクエリ文字列。「 [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US)」を参照してください。 | | X-Include-Check-Params | オプション。チェックインスタンスとそのパラメーターを結果に返すかどうかを示すフラグ。 有効な値： * true：チェックインスタンスとそのパラメーターを結果に含めます。 * false：チェックインスタンスとそのパラメーターを結果に含めません。 {#agnt_clnt_cll-GET-policies-list__ul_xmj_pyw_dpb} デフォルト値：false データタイプ：ブーリアン | | X-Include-Checks-And-Agents | オプション。チェックインスタンスとエージェントを結果に含めるかどうかを示すフラグ。 有効な値： * true：チェックインスタンスとエージェントを結果に含めます。 * false：チェックとエージェントを結果に含めません。 {#agnt_clnt_cll-GET-policies-list__ul_asz_gvw_dpb} デフォルト値：false データタイプ：ブーリアン | [表 : 76. 要求ヘッダー] {#agnt_clnt_cll-GET-policies-list__table_d1q_x5w_dpb} {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 77. 応答ヘッダー] {#agnt_clnt_cll-GET-policies-list__table_abd_scx_dpb} ### ステータスコード {#agnt_clnt_cll-GET-policies-list__section_bbd_scx_dpb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policies-list__entry-200-status-code}{#agnt_clnt_cll-GET-policies-list__agntCC-desc-403-user} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_user ロールがありません。 | [表 : 78. ステータスコード] {#agnt_clnt_cll-GET-policies-list__table_tmf_2gr_z4b} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-policies-list__entry__34}{#agnt_clnt_cll-GET-policies-list__agntCC-ph-rb-checks-sbox} | プロパティ | 説明 | |-|-| | ポリシー | 取得されたポリシーのリスト。特定の要求ヘッダーを使用してクエリした場合は、結果にチェックとエージェントが含まれます。ポリシーの詳細については、「 [デフォルトのチェックとポリシー](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。 { "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:ポリシーはアクティブではありません。 {#agnt_clnt_cll-GET-policies-list__ul_qr2_g3x_dpb} データタイプ：ブーリアン | | policies.agent_ids | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。これらの結果は、X-Include-Checks-And-Agents ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 エージェントの詳細情報を確認するには、[GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-agent_id "指定されたエージェントの情報を取得します。") エンドポイントで 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" } ] {#agnt_clnt_cll-GET-policies-list__agntCC-code-rb-checks-sbox} | | policies.checks.active | ポリシーチェックがアクティブかどうかを示すフラグ。 有効な値： * true：ポリシーチェックはアクティブです。 * false：ポリシーチェックはアクティブではありません。 {#agnt_clnt_cll-GET-policies-list__ul_j2p_sdt_2pb} データタイプ：ブール | | policies.checks.auto_generate | command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。 有効な値： * true：command プロパティにアクティブなパラメーター値を自動的に入力します。 * false:コマンドは自動的に生成されません。 {#agnt_clnt_cll-GET-policies-list__ul_myc_x2t_2pb} データタイプ：ブーリアン | | policies.checks.check_type | 監視オプションを指定するチェックタイプ。 可能な値： * Discovery：エージェントに関連する CI を検索するチェック。 * Events：チェックの結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-GET-policies-list__ul_pgd_42t_2pb} データタイプ：文字列 | | 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 | チェックインスタンス \[sn_agent_check\] テーブルにリストされているチェックの sys_id。 データタイプ：文字列 | | policies.checks.timeout | 出力が返されないときにチェックの実行が停止するまでの時間 (秒)。たとえば、値 60 は、チェックを実行して値が返されないまま 60 秒経過したときに実行が停止することを意味します。 データタイプ：文字列 | | policies.cred_alias | 資格情報 \[discovery_credentials\] テーブルにリストされている名前。 データタイプ：文字列 | | policies.credential_alias | 接続および資格情報エイリアス \[sys_alias\] テーブルの資格情報エイリアスの sys_id。 データタイプ：文字列 | | policies.filter | 指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。 データタイプ：文字列 | | policies.interval | ポリシーチェックとチェックの間に待機する時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。 注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。 データタイプ：数値 | | policies.monitored_ci_group | ポリシーに関連付けられている [CMDB グループ](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) の名前。この CMDB は CMDB グループ \[cmdb_group\] テーブルにリストされています。 このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | policies.monitored_ci_script | CI を監視するためのスクリプト。 このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | policies.monitored_ci_type_filter | CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。 有効な値： * true：チェックグループによるフィルタリングが有効です。 * false：チェックグループによるフィルタリングが無効です。 {#agnt_clnt_cll-GET-policies-list__ul_tvm_fvt_2pb} データタイプ：ブール | | policies.monitored_ci_type_group | CMDB グループタイプによる監視が有効かどうかを示すフラグ。 有効な値： * true：CMDB グループタイプは有効です。 * false：CMDB グループタイプは無効です。 {#agnt_clnt_cll-GET-policies-list__ul_jrc_fvt_2pb} データタイプ：ブール | | policies.monitored_ci_type_script | CI を監視するためのスクリプトが有効かどうかを示すフラグ。 有効な値： * true：CI を監視するためのスクリプトは有効です。 * false：CI を監視するためのスクリプトは無効です。 {#agnt_clnt_cll-GET-policies-list__ul_bs4_3wt_2pb} データタイプ：ブール | | policies.name | ポリシーの名前。 データタイプ：文字列 | | policies.publish_status | ポリシーが公開されているかどうかを示します。 可能な値： * Draft：ポリシーは公開されておらず、更新エンドポイントを使用して編集できます。 * Published：ポリシーが公開されています。ドラフト (サンドボックスのコピー) と公開済みのコピーは同じです。 * Published\*：ポリシーは公開されていますが、ドラフトコピー (サンドボックスビュー) には公開済みコピーにはない変更があります。 {#agnt_clnt_cll-GET-policies-list__ul_d3k_qzm_fpb} データタイプ：文字列 | | policies.sys_id | ポリシー \[sn_agent_policy\] テーブルにリストされているポリシーの sys_id。 データタイプ：文字列 | | policies.sys_updated_on | ポリシーが最後に更新された日時。 データタイプ：文字列 | | policies.table | ポリシーの監視対象 CI タイプフィールド。このフィールドは、monitored_ci_type_filter が true の場合にのみ適用されます。 データタイプ：文字列 | | policies.params | チェックパラメーター \[sn_agent_check_param\] テーブルにリストされているチェックパラメーターの情報を含むオブジェクトのリスト。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 データタイプ：オブジェクトのアレイ "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | policies.params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-policies-list__ul_u2x_5fv_2pb} データタイプ：ブール | | policies.params.flag | チェックの発動時に使用するパラメーターフラグ。 データタイプ：文字列 | | policies.params.mandatory | チェックが必須かどうかを示すフラグ。 有効な値： * true：このチェックは必須です。 * false：このチェックはオプションです。 {#agnt_clnt_cll-GET-policies-list__ul_flq_qkv_2pb} データタイプ：ブール | | policies.params.name | パラメーターの名前です。 データタイプ：文字列 | | policies.params.sys_id | チェックパラメーター \[sn_agent_check_param\] テーブルにリストされたパラメーターの sys_id。 データタイプ：文字列 | | policies.params.value | パラメーターの値。 データタイプ：文字列 | | policies.params.value_required | value プロパティによって提供される情報が必須かどうかを示すフラグ。 有効な値： * true：value プロパティは必須です。 * false：value プロパティは null かまたは必須ではありません。 {#agnt_clnt_cll-GET-policies-list__ul_ug3_3jv_2pb} データタイプ：ブール | | policies.secure_params | チェックセキュアパラメーター \[sn_agent_check_secure_param\] テーブルにリストされているチェックセキュアパラメーターの情報を含むオブジェクトのリスト。詳細については、「 [チェックのセキュアなパラメーターを作成する](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 データタイプ：オブジェクトのアレイ "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | policies.secure_params.active | チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックのセキュアなパラメーターはアクティブです。 * false：チェックのセキュアなパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-policies-list__ul_xwy_vfv_2pb} データタイプ：ブール | | policies.secure_params.name | セキュアパラメーターの名前。 データタイプ：文字列 | | policies.secure_params.order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：数値 | | policies.secure_params.sys_id | チェックのセキュアなパラメーター \[sn_agent_check_secure_param\] テーブルのレコードの sys_id。 データタイプ：文字列 | [表 : 79. オブジェクト] ### cURL 要求 {#agnt_clnt_cll-GET-policies-list__example_dy2_wbx_dpb} 次の例は、クエリと数値によって結果を制限する方法を示しています。クエリは、関連付けられたエージェントのすべてのアクティブなポリシーと 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} {#ariaid-title15} 公開されたポリシーをアクティブにします。 公開されたポリシーのリストについては、[GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policies-list "ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。") を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が `Published` または `Published*` である sys_id のみをサポートします。 ### URL 形式 /api/sn_agent/agents/policy/activate/{policy_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-policy-act__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-act__agntCC-entry-parm-policyID-pub} | 名前 | 説明 | |-|-| | policy_id | ポリシー \[sn_agent_policy\] テーブルにリストされている公開済みポリシーの sys_id。 データタイプ：文字列 | [表 : 80. パスパラメーター] {#agnt_clnt_cll-GET-policy-act__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 81. クエリパラメーター] {#agnt_clnt_cll-GET-policy-act__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 82. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-policy-act__table_j4n_tcx_dpb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-act__entry__14}{#agnt_clnt_cll-GET-policy-act__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 83. 要求ヘッダー] {#agnt_clnt_cll-GET-policy-act__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 84. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-act__entry-200-status-code}{#agnt_clnt_cll-GET-policy-act__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-act__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 85. ステータスコード] {#agnt_clnt_cll-GET-policy-act__table_ckp_2gr_z4b} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb__entry__2} | ヘッダー | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb} ### cURL 要求 次の例は、ポリシーをアクティブにする方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' 出力： { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/deactivate/{policy_id} {#ariaid-title16} 公開されたポリシーを無効にします。 公開されたポリシーのリストについては、[GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policies-list "ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。") を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が `Published` または `Published*` である sys_id のみをサポートします。 ### URL 形式 {#agnt_clnt_cll-GET-policy-deact__section_f4n_tcx_dpb} /api/sn_agent/agents/policy/activate/{policy_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-policy-deact__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-deact__agntCC-entry-parm-policyID-pub} | 名前 | 説明 | |-|-| | policy_id | ポリシー \[sn_agent_policy\] テーブルにリストされている公開済みポリシーの sys_id。 データタイプ：文字列 | [表 : 86. パスパラメーター] {#agnt_clnt_cll-GET-policy-deact__table_f4v_qfs_2pb} {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 87. クエリパラメーター] {#agnt_clnt_cll-GET-policy-deact__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 88. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-policy-deact__table_j4n_tcx_dpb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb__entry__2}{#agnt_clnt_cll-GET-policy-deact__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 89. 要求ヘッダー] {#agnt_clnt_cll-GET-policy-deact__table_l4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 90. 応答ヘッダー] {#agnt_clnt_cll-GET-policy-deact__table_m4n_tcx_dpb} ### ステータスコード {#agnt_clnt_cll-GET-policy-deact__section_n4n_tcx_dpb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-deact__entry-200-status-code}{#agnt_clnt_cll-GET-policy-deact__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-deact__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 91. ステータスコード] {#agnt_clnt_cll-GET-policy-deact__table_ckp_2gr_z4b} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-policy-deact__section_znm_1mq_fpb} {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb__entry__2} | ヘッダー | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-policy-deact__table_h5l_bgs_2pb} ### cURL 要求 {#agnt_clnt_cll-GET-policy-deact__example_bgj_chs_2pb} 次の例は、ポリシーを無効にする方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' 出力： { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/publish/{policy_id} {#ariaid-title17} ドラフトポリシーを公開します。 公開前にドラフトまたはサンドボックスのコピーを変更するには、次のいずれかのエンドポイントを使用します。 * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-policy "ポリシーのサンドボックスコピーを更新します。") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check-id "選択したポリシーチェックを更新します。") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_param "選択したポリシーチェックパラメーターを更新します。") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_secure "選択したポリシーのチェックセキュアなパラメーターを更新します。") {#agnt_clnt_cll-GET-policy-publish__ul_p14_jbh_fpb} ### URL 形式 /api/sn_agent/agents/policy/publish/{policy_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-policy-publish__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb__entry__2} | 名前 | 説明 | |-|-| | policy_id | 「ドラフト」ステータスまたはサンドボックスのコピーである、ポリシー \[sn_agent_policy\] テーブル内のポリシーの sys_id。 * ポリシーおよび公開ステータスを含む詳細のリストについては、[GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policies-list "ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。") を使用します。 * ポリシーのサンドボックスコピーを取得するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用します。 {#agnt_clnt_cll-GET-policy-publish__ul_icv_npn_fpb} データタイプ：文字列 | [表 : 92. パスパラメーター] {#agnt_clnt_cll-GET-policy-publish__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 93. クエリパラメーター] {#agnt_clnt_cll-GET-policy-publish__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 94. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-policy-publish__table_j4n_tcx_dpb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-publish__entry__14}{#agnt_clnt_cll-GET-policy-publish__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 95. 要求ヘッダー] {#agnt_clnt_cll-GET-policy-publish__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 96. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-publish__entry-200-status-code}{#agnt_clnt_cll-GET-policy-publish__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-publish__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 97. ステータスコード] {#agnt_clnt_cll-GET-policy-publish__table_ckp_2gr_z4b} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-policy-publish__section_m1q_bmq_fpb} {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb__entry__2} | ヘッダー | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb} ### cURL 要求 次の例は、ポリシーを公開する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/" \ --request GET \ --header "Accept:application/json" \ --user 'username' : 'password' 出力： { "message": "Operation was successful" } ## Agent Client Collector - GET /agents/policy/sandbox_from_published/{policy_id} {#ariaid-title18} 公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。 サンドボックスのコピーを使用してポリシーを更新し、公開します。応答本文の sys_id を使用して、次のエンドポイントを操作できます。 * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-policy "ポリシーのサンドボックスコピーを更新します。") * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check-id "選択したポリシーチェックを更新します。") * [POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_param "選択したポリシーチェックパラメーターを更新します。") * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_secure "選択したポリシーのチェックセキュアなパラメーターを更新します。") {#agnt_clnt_cll-GET-policy-sbox-fr__ul_p14_jbh_fpb} 公開されたポリシーのリストについては、[GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policies-list "ステータスが公開済みまたは未公開ドラフトであるポリシーのリストを取得します。") を使用します。このエンドポイントは、ポリシーの publish_status プロパティの値が `Published` または `Published*` である sys_id のみをサポートします。 ### URL 形式 /api/sn_agent/agents/policy/sandbox_from_published/{policy_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-policy-sbox-fr__section_g4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-entry-parm-policyID-pub} | 名前 | 説明 | |-|-| | policy_id | ポリシー \[sn_agent_policy\] テーブルにリストされている公開済みポリシーの sys_id。 データタイプ：文字列 | [表 : 98. パスパラメーター] {#agnt_clnt_cll-GET-policy-sbox-fr__table_n3g_1fs_2pb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 99. クエリパラメーター] {#agnt_clnt_cll-GET-policy-sbox-fr__table_i4n_tcx_dpb} {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 100. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-policy-sbox-fr__table_j4n_tcx_dpb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-sbox-fr__entry__14}{#agnt_clnt_cll-GET-policy-sbox-fr__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 101. 要求ヘッダー] {#agnt_clnt_cll-GET-policy-sbox-fr__entry__18} | ヘッダー | 説明 | |-|-| | なし | | [表 : 102. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b__entry__2}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-200-status-code}{#agnt_clnt_cll-GET-policy-sbox-fr__agntCC-desc-403-admin}{#agnt_clnt_cll-GET-policy-sbox-fr__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 103. ステータスコード] {#agnt_clnt_cll-GET-policy-sbox-fr__table_ckp_2gr_z4b} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-policy-sbox-fr__entry__32} | プロパティ | 説明 | |-|-| | \ | ポリシーに関連付けられたサンドボックスコピーの拡張詳細。ポリシーの詳細については、「 [デフォルトのチェックとポリシー](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。 { "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" } | | active | ポリシーがアクティブかどうかを示すフラグ。 有効な値： * true：ポリシーはアクティブです。 * false:ポリシーはアクティブではありません。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_qr2_g3x_dpb} データタイプ：ブーリアン | | agent_ids | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。これらの結果は、X-Include-Checks-And-Agents ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 エージェントの詳細情報を確認するには、[GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-agent_id "指定されたエージェントの情報を取得します。") エンドポイントで 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：ポリシーチェックはアクティブではありません。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_j2p_sdt_2pb} データタイプ：ブール | | checks.auto_generate | command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。 有効な値： * true：command プロパティにアクティブなパラメーター値を自動的に入力します。 * false:コマンドは自動的に生成されません。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_myc_x2t_2pb} データタイプ：ブーリアン | | checks.check_type | 監視オプションを指定するチェックタイプ。 可能な値： * Discovery：エージェントに関連する CI を検索するチェック。 * Events：チェックの結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_pgd_42t_2pb} データタイプ：文字列 | | 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 | チェックインスタンス \[sn_agent_check\] テーブルにリストされているチェックの sys_id。[POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check-id "選択したポリシーチェックを更新します。") エンドポイントは、この値を取得してサンドボックスのコピーを更新します。 データタイプ：文字列 | | checks.timeout | 出力が返されないときにチェックの実行が停止するまでの時間 (秒)。たとえば、値 60 は、チェックを実行して値が返されないまま 60 秒経過したときに実行が停止することを意味します。 データタイプ：文字列 | | cred_alias | 資格情報 \[discovery_credentials\] テーブルにリストされている名前。 データタイプ：文字列 | | credential_alias | 接続および資格情報エイリアス \[sys_alias\] テーブルの資格情報エイリアスの sys_id。 データタイプ：文字列 | | filter | 指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。 データタイプ：文字列 | | interval | ポリシーチェックとチェックの間に待機する時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。 注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。 データタイプ：数値 | | monitored_ci_group | ポリシーに関連付けられている [CMDB グループ](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) の名前。この CMDB は CMDB グループ \[cmdb_group\] テーブルにリストされています。 このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | monitored_ci_script | CI を監視するためのスクリプト。 このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | monitored_ci_type_filter | CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。 有効な値： * true：チェックグループによるフィルタリングが有効です。 * false：チェックグループによるフィルタリングが無効です。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_tvm_fvt_2pb} データタイプ：ブール | | monitored_ci_type_group | CMDB グループタイプによる監視が有効かどうかを示すフラグ。 有効な値： * true：CMDB グループタイプは有効です。 * false：CMDB グループタイプは無効です。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_jrc_fvt_2pb} データタイプ：ブール | | monitored_ci_type_script | CI を監視するためのスクリプトが有効かどうかを示すフラグ。 有効な値： * true：CI を監視するためのスクリプトは有効です。 * false：CI を監視するためのスクリプトは無効です。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_bs4_3wt_2pb} データタイプ：ブール | | name | ポリシーの名前。 データタイプ：文字列 | | publish_status | ポリシーが公開されているかどうかを示します。 可能な値： * Draft：ポリシーは公開されておらず、更新エンドポイントを使用して編集できます。 * Published：ポリシーが公開されています。ドラフト (サンドボックスのコピー) と公開済みのコピーは同じです。 * Published\*：ポリシーは公開されていますが、ドラフトコピー (サンドボックスビュー) には公開済みコピーにはない変更があります。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_d3k_qzm_fpb} データタイプ：文字列 | | params | チェックパラメーター \[sn_agent_check_param\] テーブルにリストされているチェックパラメーターの情報を含むオブジェクトのリスト。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 データタイプ：オブジェクトのアレイ "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] | | params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_u2x_5fv_2pb} データタイプ：ブール | | params.flag | チェックの発動時に使用するパラメーターフラグ。 データタイプ：文字列 | | params.mandatory | チェックが必須かどうかを示すフラグ。 有効な値： * true：このチェックは必須です。 * false：このチェックはオプションです。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_flq_qkv_2pb} データタイプ：ブール | | params.name | パラメーターの名前です。 データタイプ：文字列 | | params.sys_id | チェックパラメーター \[sn_agent_check_param\] テーブルにリストされたパラメーターの sys_id。[POST /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_param "選択したポリシーチェックパラメーターを更新します。") エンドポイントは、この値を取得してサンドボックスのコピーを更新します。 データタイプ：文字列 | | params.value | パラメーターの値。 データタイプ：文字列 | | params.value_required | value プロパティによって提供される情報が必須かどうかを示すフラグ。 有効な値： * true：value プロパティは必須です。 * false：value プロパティは null かまたは必須ではありません。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_ug3_3jv_2pb} データタイプ：ブール | | secure_params | チェックセキュアパラメーター \[sn_agent_check_secure_param\] テーブルにリストされているチェックセキュアパラメーターの情報を含むオブジェクトのリスト。詳細については、「 [チェックのセキュアなパラメーターを作成する](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。これらの結果は、X-Include-Check-Params ヘッダーパラメーターが true に設定されている場合にのみ表示されます。 データタイプ：オブジェクトのアレイ "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] | | secure_params.active | チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックのセキュアなパラメーターはアクティブです。 * false：チェックのセキュアなパラメーターは非アクティブです。 {#agnt_clnt_cll-GET-policy-sbox-fr__ul_xwy_vfv_2pb} データタイプ：ブール | | secure_params.name | セキュアパラメーターの名前。 データタイプ：文字列 | | secure_params.order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：数値 | | secure_params.sys_id | チェックセキュアなパラメーター \[sn_agent_check_secure_param\] テーブルにあるレコードの sys_id。[POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-check_secure "選択したポリシーのチェックセキュアなパラメーターを更新します。") エンドポイントは、この値を取得してサンドボックスのコピーを更新します。 データタイプ：文字列 | | sys_id | ポリシー \[sn_agent_policy\] テーブルにリストされているポリシーの sys_id。[POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-POST-update-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/" \ --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 {#ariaid-title19} アライブ/稼働ステータスの指定されたエージェントを再起動します。 エージェントクライアントコレクター のパフォーマンスの問題が発生した場合は、エージェントを再起動できます。手動再起動は次の環境でサポートされています。 * `systemd` を使用する Linux ベースのエージェント * Windows エージェント {#agnt_clnt_cll-GET-restart__ul_zzv_z4q_dpb} ### URL 形式 {#agnt_clnt_cll-GET-restart__section_nf5_zyc_z4b} /api/sn_agent/agents/{agent_id}/restart ### サポートされている要求パラメーター {#agnt_clnt_cll-GET-restart__section_ewl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb__entry__2} | 名前 | 説明 | |-|-| | agent_id | Agent Client Collector \[sn_agent_cmdb_ci_agent\] テーブルの \[Agent ID\] 列にリストされるエージェントの一意の ID。 エージェント ID のリストおよびその他の詳細については、GET /agents/list エンドポイントを実行してください。 データタイプ：文字列 | [表 : 104. パスパラメーター] {#agnt_clnt_cll-GET-restart__table_oyt_cd3_dpb} {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 105. クエリパラメーター] {#agnt_clnt_cll-GET-restart__table_gwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 106. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-GET-restart__table_hwl_zyc_z4b} ### ヘッダー {#agnt_clnt_cll-GET-restart__section_iwl_zyc_z4b} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b__entry__2}{#agnt_clnt_cll-GET-restart__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 107. 要求ヘッダー] {#agnt_clnt_cll-GET-restart__table_jwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 108. 応答ヘッダー] {#agnt_clnt_cll-GET-restart__table_kwl_zyc_z4b} ### ステータスコード {#agnt_clnt_cll-GET-restart__section_lwl_zyc_z4b} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb__entry__2}{#agnt_clnt_cll-GET-restart__entry-200-status-code}{#agnt_clnt_cll-GET-restart__agntCC-desc-403-admin} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つからないか、このエージェントが再起動をサポートしていません。 | [表 : 109. ステータスコード] {#agnt_clnt_cll-GET-restart__table_y2n_2f3_dpb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-GET-restart__section_nwl_zyc_z4b} {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-GET-restart__table_owl_zyc_z4b} ### cURL 要求 {#agnt_clnt_cll-GET-restart__example_zf5_zyc_z4b} 次の例は、エージェントを再起動する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents//restart" \ --request GET \ --header "Accept:application/json" \ --user 'username':'password' 出力： { "message": "Restarting Agent With ID: " } ## Agent Client Collector - POST /agents/check_defs/{check_def_id}/run {#ariaid-title20} 指定された構成アイテムに対してチェックを実行します。 バックグラウンドチェックを停止するには、GET /agents/exec/background/stop/{request_id} API で指定された要求 ID を使用します。 ### URL 形式 /api/sn_agent/agents/check_defs/{check_def_id}/run ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-check-def-run__entry__2} | 名前 | 説明 | |-|-| | check_def_id | チェック定義 \[sn_agent_check_def\] テーブルのチェック定義の sys_id。 | [表 : 110. パスパラメーター] {#agnt_clnt_cll-POST-check-def-run__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 111. クエリパラメーター] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb__entry__2} | 名前 | 説明 | |-|-| | params | パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 "params": { "": "String" } データタイプ：オブジェクト | | priority | ECC キューに設定される要求の優先度。 可能な値： * 0：インタラクティブ * 1：迅速化済み * 2：標準 {#agnt_clnt_cll-POST-check-def-run__ul_bkf_hnq_wqb} データタイプ：数値 | | クエリ | table プロパティで指定されたテーブルから GlideRecord を取得するためのエンコードされたクエリ。 データタイプ：文字列 | | table | このバックグラウンドチェックの cmdb_ci テーブルの名前。 データタイプ：文字列 | | timeout | 要求のタイムアウト値 (秒)。 データタイプ：数値 | [表 : 112. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-check-def-run__table_cvh_5gq_wqb} ### ヘッダー {#agnt_clnt_cll-POST-check-def-run__section_dvh_5gq_wqb} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 113. 要求ヘッダー] {#agnt_clnt_cll-POST-check-def-run__table_evh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 114. 応答ヘッダー] {#agnt_clnt_cll-POST-check-def-run__table_fvh_5gq_wqb} ### ステータスコード {#agnt_clnt_cll-POST-check-def-run__section_gvh_5gq_wqb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb__entry__2}{#agnt_clnt_cll-POST-check-def-run__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 400 | 要求本文で指定された引数にエラーがあります。 | | 404 | 指定された ID のチェック定義が見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 115. ステータスコード] {#agnt_clnt_cll-POST-check-def-run__table_hvh_5gq_wqb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-check-def-run__section_ivh_5gq_wqb} {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb__entry__2} | 名前 | 説明 | |-|-| | requestId | 生成されたバックグラウンドチェック要求の sys_id。 | [ ] {#agnt_clnt_cll-POST-check-def-run__table_jvh_5gq_wqb} ### cURL 要求 {#agnt_clnt_cll-POST-check-def-run__example_kvh_5gq_wqb} 次の例は、バックグラウンドチェックを実行してその要求 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 {#ariaid-title21} チェック定義に対するテストチェック要求の構築を有効にします。 この API は次のタスクに使用します。 * テストするチェック定義を設定 * テストを実行するための構成アイテムを設定 {#agnt_clnt_cll-POST-check-def-test__ul_tdb_gpk_5qb}テスト中に使用する次のいずれかの識別子を指定することもできます。 * 資格情報 sys_id * 資格情報エイリアス ID * 資格情報名 {#agnt_clnt_cll-POST-check-def-test__ul_tft_qwk_5qb} ### URL 形式 /api/sn_agent/agents/check_defs/{check_def_id}/test ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-check-def-test__entry__2} | 名前 | 説明 | |-|-| | check_def_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 | [表 : 116. パスパラメーター] {#agnt_clnt_cll-POST-check-def-test__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 117. クエリパラメーター] {#agnt_clnt_cll-POST-check-def-test__entry__10} | 名前 | 説明 | |-|-| | ci_id | CMDB 構成アイテムの sys_id | | credentials_id | 資格情報レコードの sys_id。 | | credentials_name | 資格情報レコードの名前。 | | credentials_alias_id | 資格情報エイリアスレコードの sys_id。 | | credentials_alias_name | 資格情報エイリアスの名前。 | [表 : 118. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-def-test__entry__22}{#agnt_clnt_cll-POST-check-def-test__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 119. 要求ヘッダー] {#agnt_clnt_cll-POST-check-def-test__entry__26} | ヘッダー | 説明 | |-|-| | なし | | [表 : 120. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-def-test__entry__30}{#agnt_clnt_cll-POST-check-def-test__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 500 | テスト要求の構築中にエラーが発生しました。 | [表 : 121. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-check-def-test__section_d5l_yrv_wqb} {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb__entry__2} | 名前 | 説明 | |-|-| | result_id | テスト結果レコードの sys_id。 | [ ] {#agnt_clnt_cll-POST-check-def-test__table_e5l_yrv_wqb} ## Agent Client Collector - POST /agents/check_instances/{check_instance_id}/test {#ariaid-title22} チェックインスタンスに対するテストチェック要求の構築を有効にします。 この API は次のタスクに使用します。 * テストするチェックインスタンスを設定 * テストを実行するための構成アイテムを設定 {#agnt_clnt_cll-POST-check-inst-test__ul_tdb_gpk_5qb}テスト中に使用する次のいずれかの識別子を指定することもできます。 * 資格情報 sys_id * 資格情報エイリアス ID * 資格情報名 {#agnt_clnt_cll-POST-check-inst-test__ul_tft_qwk_5qb} ### URL 形式 /api/sn_agent/agents/check_instances/{check_instance_id}/test ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-check-inst-test__entry__2} | 名前 | 説明 | |-|-| | check_instance_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 | [表 : 122. パスパラメーター] {#agnt_clnt_cll-POST-check-inst-test__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 123. クエリパラメーター] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb__entry__2} | 名前 | 説明 | |-|-| | 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\] 列にリストされます。 | [表 : 124. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-check-inst-test__table_obs_krv_wqb} ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-inst-test__entry__24}{#agnt_clnt_cll-POST-check-inst-test__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 125. 要求ヘッダー] {#agnt_clnt_cll-POST-check-inst-test__entry__28} | ヘッダー | 説明 | |-|-| | なし | | [表 : 126. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb__entry__2}{#agnt_clnt_cll-POST-check-inst-test__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 500 | テスト要求の構築中にエラーが発生しました。 | [表 : 127. ステータスコード] {#agnt_clnt_cll-POST-check-inst-test__table_b2r_5gr_wqb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-check-inst-test__entry__38} | 名前 | 説明 | |-|-| | result_id | テスト結果レコードの sys_id。 | [ ] ## Agent Client Collector - POST /agents/update/check/{check_id} {#ariaid-title23} 選択したポリシーチェックを更新します。 ポリシーのサンドボックスコピーのプロパティを取得するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用します。 ### URL 形式 /api/sn_agent/agents/update/check/{check_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-update-check-id__section_vvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb__entry__2} | 名前 | 説明 | |-|-| | check_id | チェックインスタンス \[sn_agent_check\] テーブル内のポリシーチェックのサンドボックスコピーの sys_id。 データタイプ：文字列 | [表 : 128. パスパラメーター] {#agnt_clnt_cll-POST-update-check-id__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 129. クエリパラメーター] {#agnt_clnt_cll-POST-update-check-id__table_wvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | active | ポリシーチェックがアクティブかどうかを示すフラグ。 有効な値： * true：ポリシーチェックはアクティブです。 * false：ポリシーチェックはアクティブではありません。 {#agnt_clnt_cll-POST-update-check-id__ul_j2p_sdt_2pb} データタイプ：ブール | | auto_generate | command_prefix 値を使用してコマンドを自動的に生成するかどうかを示すフラグ。 有効な値： * true：command プロパティにアクティブなパラメーター値を自動的に入力します。 * false:コマンドは自動的に生成されません。 {#agnt_clnt_cll-POST-update-check-id__ul_myc_x2t_2pb} データタイプ：ブーリアン | | check_type | 監視オプションを指定するチェックタイプ。 可能な値： * Discovery：エージェントに関連する CI を検索するチェック。 * Events：チェックの結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-POST-update-check-id__ul_pgd_42t_2pb} データタイプ：文字列 | | 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 秒経過したときに実行が停止することを意味します。 データタイプ：文字列 | [表 : 130. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-update-check-id__table_xvx_g2z_2pb} ### ヘッダー {#agnt_clnt_cll-POST-update-check-id__section_yvx_g2z_2pb} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 131. 要求ヘッダー] {#agnt_clnt_cll-POST-update-check-id__table_zvx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 132. 応答ヘッダー] {#agnt_clnt_cll-POST-update-check-id__table_awx_g2z_2pb} ### ステータスコード {#agnt_clnt_cll-POST-update-check-id__section_bwx_g2z_2pb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check-id__entry-200-status-code}{#agnt_clnt_cll-POST-update-check-id__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check-id__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 133. ステータスコード] {#agnt_clnt_cll-POST-update-check-id__table_cwx_g2z_2pb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-update-check-id__section_dwx_g2z_2pb} {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-POST-update-check-id__table_ewx_g2z_2pb} ### cURL 要求 {#agnt_clnt_cll-POST-update-check-id__example_fwx_g2z_2pb} 次の例は、ポリシーチェックのイベント変更および修理プロパティを更新する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/update/check/" \ --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} {#ariaid-title24} 指定されたチェックパラメーターの 1 つ以上のフィールド値を変更できるようにします。 ### URL 形式 /api/sn_agent/agents/update/check_def_params/{check_def_param_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-up-check-def-p__entry__2} | 名前 | 説明 | |-|-| | check_def_param_id | チェックパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 データタイプ：文字列 | [表 : 134. パスパラメーター] {#agnt_clnt_cll-POST-up-check-def-p__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 135. クエリパラメーター] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb__entry__2} | 名前 | 説明 | |-|-| | active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-POST-up-check-def-p__ul_pnb_jyc_wqb} データタイプ：ブーリアン | | default_value | このチェックパラメーターのデフォルト値を指定します。 データタイプ：文字列 | | mandatory | チェックパラメーターが必須かどうかを示すフラグ。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#agnt_clnt_cll-POST-up-check-def-p__ul_wtg_2zc_wqb} データタイプ：ブーリアン | | name | チェックパラメーターの名前。 データタイプ：文字列 | [表 : 136. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb} 注: チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。 ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-p__entry__20}{#agnt_clnt_cll-POST-up-check-def-p__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 137. 要求ヘッダー] {#agnt_clnt_cll-POST-up-check-def-p__entry__24} | ヘッダー | 説明 | |-|-| | なし | | [表 : 138. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-p__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 404 | 指定された sys_id のチェックパラメーターが見つかりませんでした。 | | 500 | チェックパラメーターの更新中にエラーが発生しました。 | [表 : 139. ステータスコード] {#agnt_clnt_cll-POST-up-check-def-p__table_tfm_ykr_wqb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb__entry__2} | 名前 | 説明 | |-|-| | なし | 成功またはエラーメッセージ。 | [ ] {#agnt_clnt_cll-POST-up-check-def-p__table_t3p_kmr_wqb} ### 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} {#ariaid-title25} 指定されたチェックセキュアパラメーターの 1 つ以上のフィールド値を変更できるようにします。 ### URL 形式 /api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-up-check-def-sp__entry__2} | 名前 | 説明 | |-|-| | check_def_secure_param_id | チェックセキュアなパラメーター定義 \[sn_agent_check_secure_param_def\] テーブルにリストされたセキュアパラメーターの sys_id。 データタイプ：文字列 | [表 : 140. パスパラメーター] {#agnt_clnt_cll-POST-up-check-def-sp__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 141. クエリパラメーター] {#agnt_clnt_cll-POST-up-check-def-sp__entry__10} | 名前 | 説明 | |-|-| | active | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#agnt_clnt_cll-POST-up-check-def-sp__ul_g1b_3vc_wqb} データタイプ：ブーリアン | | name | セキュアパラメーターの名前。 データタイプ：文字列 | | order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：文字列 | [表 : 142. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-sp__entry__18}{#agnt_clnt_cll-POST-up-check-def-sp__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 143. 要求ヘッダー] {#agnt_clnt_cll-POST-up-check-def-sp__entry__22} | ヘッダー | 説明 | |-|-| | なし | | [表 : 144. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb__entry__2}{#agnt_clnt_cll-POST-up-check-def-sp__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 404 | 指定された sys_id のチェックセキュアなパラメーターが見つかりませんでした。 | | 500 | チェックセキュアなパラメーターの更新中にエラーが発生しました。 | [表 : 145. ステータスコード] {#agnt_clnt_cll-POST-up-check-def-sp__table_rst_ykr_wqb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb__entry__2} | 名前 | 説明 | |-|-| | なし | 成功またはエラーメッセージ。 | [ ] {#agnt_clnt_cll-POST-up-check-def-sp__table_lfq_5kr_wqb} ### 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} {#ariaid-title26} 指定されたチェック定義の 1 つ以上のフィールド値を変更できるようにします。 ### URL 形式 /api/sn_agent/agents/update/check_defs/{check_def_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-up-check-def-cd__entry__2} | 名前 | 説明 | |-|-| | check_def_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 データタイプ：文字列 | [表 : 146. パスパラメーター] {#agnt_clnt_cll-POST-up-check-def-cd__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 147. クエリパラメーター] {#agnt_clnt_cll-POST-up-check-def-cd__entry__10} | 名前 | 説明 | |-|-| | active | このチェック定義がアクティブかどうかを示します。 有効な値： * 0：このチェック定義は非アクティブです。 * 1：このチェック定義はアクティブです。 {#agnt_clnt_cll-POST-up-check-def-cd__ul_gdc_4wj_wqb} データタイプ：数値 | | background | このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始するチェックであり、エージェントが実行を終了するまで待機しません。 有効な値： * true：このチェック定義はバックグラウンドチェックです。 * false：このチェック定義はバックグラウンドチェックではありません。 {#agnt_clnt_cll-POST-up-check-def-cd__ul_ypb_5ps_5qb} データタイプ：ブール | | check_group | このチェック定義に指定されたグループ。 | | check_type | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#agnt_clnt_cll-POST-up-check-def-cd__ul_gtr_kfb_wqb} データタイプ：文字列 | | command | エージェントクライアントコレクター が実行するコマンド。 データタイプ：文字列 | | name | チェックの名前。 データタイプ：文字列 | | params | パラメーターの名前と値のマップ。これらの設定を使用して、チェック定義のパラメーターレコードとその指定された値を上書きできます。 "params": { "": "String" } データタイプ：オブジェクト | | プラグイン | のリスト [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) このチェックに関連付けられています。 データタイプ：アレイ | | proxy_valid | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#agnt_clnt_cll-POST-up-check-def-cd__ul_wbf_qps_5qb} データタイプ：ブーリアン | | クエリ | table プロパティで指定されたテーブルから GlideRecord を取得するためのエンコードされたクエリ。 データタイプ：文字列 | | table | このチェックの cmdb_ci テーブルの名前。 データタイプ：文字列 | | timeout | タイムアウト (秒)。 データタイプ：数値 | [表 : 148. 要求本文パラメーター (JSON)] 注: チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。 ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-cd__entry__36}{#agnt_clnt_cll-POST-up-check-def-cd__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 149. 要求ヘッダー] {#agnt_clnt_cll-POST-up-check-def-cd__entry__40} | ヘッダー | 説明 | |-|-| | なし | | [表 : 150. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-up-check-def-cd__entry__44}{#agnt_clnt_cll-POST-up-check-def-cd__entry-200-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 404 | 指定された sys_id のチェック定義が見つかりませんでした。 | | 500 | チェック定義の更新中にエラーが発生しました。 | [表 : 151. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-up-check-def-cd__entry__52} | 名前 | 説明 | |-|-| | なし | 成功またはエラーメッセージ。 | [ ] ### 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} {#ariaid-title27} 選択したポリシーチェックパラメーターを更新します。 ポリシーのサンドボックスコピーのプロパティを取得するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用します。 ### URL 形式 /api/sn_agent/agents/update/check_param/{param_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-update-check_param__section_dvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb__entry__2} | 名前 | 説明 | |-|-| | param_id | チェックパラメーター \[sn_agent_check_param\] テーブル内のチェックパラメーターのサンドボックスコピーの sys_id。 データタイプ：文字列 | [表 : 152. パスパラメーター] {#agnt_clnt_cll-POST-update-check_param__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 153. クエリパラメーター] {#agnt_clnt_cll-POST-update-check_param__table_evh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#agnt_clnt_cll-POST-update-check_param__ul_u2x_5fv_2pb} データタイプ：ブール | | フラグ | | | mandatory | チェックが必須かどうかを示すフラグ。 有効な値： * true：このチェックは必須です。 * false：このチェックはオプションです。 {#agnt_clnt_cll-POST-update-check_param__ul_flq_qkv_2pb} データタイプ：ブール | | name | パラメーターの名前です。 データタイプ：文字列 | | value | パラメーターの値。 データタイプ：文字列 | | value_required | value プロパティによって提供される情報が必須かどうかを示すフラグ。 有効な値： * true：value プロパティは必須です。 * false：value プロパティは null かまたは必須ではありません。 {#agnt_clnt_cll-POST-update-check_param__ul_ug3_3jv_2pb} データタイプ：ブール | [表 : 154. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-update-check_param__table_fvh_g2z_2pb} ### ヘッダー {#agnt_clnt_cll-POST-update-check_param__section_gvh_g2z_2pb} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 155. 要求ヘッダー] {#agnt_clnt_cll-POST-update-check_param__table_hvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 156. 応答ヘッダー] {#agnt_clnt_cll-POST-update-check_param__table_ivh_g2z_2pb} ### ステータスコード {#agnt_clnt_cll-POST-update-check_param__section_jvh_g2z_2pb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_param__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_param__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_param__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 157. ステータスコード] {#agnt_clnt_cll-POST-update-check_param__table_kvh_g2z_2pb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-update-check_param__section_lvh_g2z_2pb} {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-POST-update-check_param__table_mvh_g2z_2pb} ### cURL 要求 {#agnt_clnt_cll-POST-update-check_param__example_nvh_g2z_2pb} 次の例は、ポリシーチェックパラメーターのいくつかのプロパティを更新する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/" \ --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} {#ariaid-title28} 選択したポリシーのチェックセキュアなパラメーターを更新します。 ポリシーのサンドボックスコピーのプロパティを取得するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用します。 ### URL 形式 /api/sn_agent/agents/update/check_secure_param/{param_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-update-check_secure__section_dzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb__entry__2} | 名前 | 説明 | |-|-| | param_id | チェックセキュアなパラメーター \[sn_agent_check_secure_param\] テーブル内のポリシーのチェックセキュアなパラメーターのサンドボックスコピーの sys_id。 データタイプ：文字列 | [表 : 158. パスパラメーター] {#agnt_clnt_cll-POST-update-check_secure__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb__entry__2} | 名前 | 説明 | |-|-| | なし | | [表 : 159. クエリパラメーター] {#agnt_clnt_cll-POST-update-check_secure__table_ezx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb__entry__2} | 名前 | 説明 | |-|-| | active | チェックのセキュアなパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックのセキュアなパラメーターはアクティブです。 * false：チェックのセキュアなパラメーターは非アクティブです。 {#agnt_clnt_cll-POST-update-check_secure__ul_xwy_vfv_2pb} データタイプ：ブール | | name | セキュアパラメーターの名前。 データタイプ：文字列 | | order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：数値 | [表 : 160. 要求本文パラメーター (JSON)] {#agnt_clnt_cll-POST-update-check_secure__table_fzx_f2z_2pb} ### ヘッダー {#agnt_clnt_cll-POST-update-check_secure__section_gzx_f2z_2pb} 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 161. 要求ヘッダー] {#agnt_clnt_cll-POST-update-check_secure__table_hzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb__entry__2} | ヘッダー | 説明 | |-|-| | なし | | [表 : 162. 応答ヘッダー] {#agnt_clnt_cll-POST-update-check_secure__table_izx_f2z_2pb} ### ステータスコード {#agnt_clnt_cll-POST-update-check_secure__section_jzx_f2z_2pb} この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb__entry__2}{#agnt_clnt_cll-POST-update-check_secure__entry-200-status-code}{#agnt_clnt_cll-POST-update-check_secure__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-check_secure__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 163. ステータスコード] {#agnt_clnt_cll-POST-update-check_secure__table_kzx_f2z_2pb} ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-update-check_secure__section_lzx_f2z_2pb} {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb__entry__2} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] {#agnt_clnt_cll-POST-update-check_secure__table_mzx_f2z_2pb} ### cURL 要求 {#agnt_clnt_cll-POST-update-check_secure__example_nzx_f2z_2pb} 次の例は、ポリシーのチェックセキュアなパラメーターのプロパティを更新する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/" \ --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} {#ariaid-title29} ポリシーのサンドボックスコピーを更新します。 ポリシーのサンドボックスコピーのプロパティを取得するには、[GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-GET-policy-sbox-fr "公開されたポリシーのサンドボックスコピーを取得し、ポリシーの詳細を提供します。") を使用します。 ### URL 形式 /api/sn_agent/agents/update/policy/{policy_id} ### サポートされている要求パラメーター {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb__entry__2} | 名前 | 説明 | |-|-| | policy_id | ポリシー \[sn_agent_policy\] テーブル内のポリシーのサンドボックスコピーの sys_id。 データタイプ：文字列 | [表 : 164. パスパラメーター] {#agnt_clnt_cll-POST-update-policy__table_n3g_1fs_2pb} {#agnt_clnt_cll-POST-update-policy__entry__6} | 名前 | 説明 | |-|-| | なし | | [表 : 165. クエリパラメーター] {#agnt_clnt_cll-POST-update-policy__entry__10} | 名前 | 説明 | |-|-| | cred_alias | 資格情報 \[discovery_credentials\] テーブルにリストされている名前。 データタイプ：文字列 | | credential_alias | 接続および資格情報エイリアス \[sys_alias\] テーブルの資格情報エイリアスの sys_id。 データタイプ：文字列 | | filter | 指定された基準のみを監視するようにポリシーのチェックを制限するフィルター。 データタイプ：文字列 | | interval | ポリシーチェックとチェックの間に待機する時間 (秒)。たとえば、値 60 は、チェックが 60 秒ごとに実行されることを意味します。 注: checks.interval プロパティの値は、このフィールドで設定された値を上書きします。 データタイプ：数値 | | monitored_ci_group | ポリシーに関連付けられている [CMDB グループ](https://www.servicenow.com/docs/access?context=cmdb-groups&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US) の名前。この CMDB は CMDB グループ \[cmdb_group\] テーブルにリストされています。 このフィールドは、monitored_ci_type_group プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | monitored_ci_script | CI を監視するためのスクリプト。 このフィールドは、policies.monitored_ci_type_script プロパティの値が true の場合にのみ適用されます。 データタイプ：文字列 | | monitored_ci_type_filter | CI タイプによるフィルタリングが有効かどうかを示すフラグ。CI タイプは table プロパティにリストされています。 有効な値： * true：チェックグループによるフィルタリングが有効です。 * false：チェックグループによるフィルタリングが無効です。 {#agnt_clnt_cll-POST-update-policy__ul_tvm_fvt_2pb} データタイプ：ブール | | monitored_ci_type_group | CMDB グループタイプによる監視が有効かどうかを示すフラグ。 有効な値： * true：CMDB グループタイプは有効です。 * false：CMDB グループタイプは無効です。 {#agnt_clnt_cll-POST-update-policy__ul_jrc_fvt_2pb} データタイプ：ブール | | monitored_ci_type_script | CI を監視するためのスクリプトが有効かどうかを示すフラグ。 有効な値： * true：CI を監視するためのスクリプトは有効です。 * false：CI を監視するためのスクリプトは無効です。 {#agnt_clnt_cll-POST-update-policy__ul_bs4_3wt_2pb} データタイプ：ブール | | name | ポリシーの名前。 データタイプ：文字列 | | table | ポリシーの監視対象 CI タイプフィールド。このフィールドは、monitored_ci_type_filter が true の場合にのみ適用されます。 データタイプ：文字列 | [表 : 166. 要求本文パラメーター (JSON)] ### ヘッダー 次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-policy__entry__34}{#agnt_clnt_cll-POST-update-policy__accept-JSON-only-entry-RESTAPI} | ヘッダー | 説明 | |-|-| | 承認 | 応答本文のデータフォーマット。application/json のみをサポートします。 | [表 : 167. 要求ヘッダー] {#agnt_clnt_cll-POST-update-policy__entry__38} | ヘッダー | 説明 | |-|-| | なし | | [表 : 168. 応答ヘッダー] ### ステータスコード この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。 {#agnt_clnt_cll-POST-update-policy__entry__42}{#agnt_clnt_cll-POST-update-policy__entry-200-status-code}{#agnt_clnt_cll-POST-update-policy__agntCC-desc-403-admin}{#agnt_clnt_cll-POST-update-policy__entry-500-status-code} | ステータスコード | 説明 | |-|-| | 200 | 成功。要求が正常に処理されました。 | | 403 | ユーザーに agent_client_collector_admin ロールがありません。 | | 404 | 指定された sys_id のレコードが見つかりません。 | | 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 | [表 : 169. ステータスコード] ### 応答本文のパラメーター (JSON) {#agnt_clnt_cll-POST-update-policy__entry__52} | 名前 | 説明 | |-|-| | message | 操作の成功または失敗の結果を含むメッセージ。 データタイプ：文字列 | [ ] ### cURL 要求 次の例は、ポリシーの名前およびフィルタープロパティ/フィールドを更新する方法を示しています。 curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/" \--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" }