---
sourceDocument: 호주 API 참조
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ko-KR/api-reference

 Release :

    - australia

ft:locale :

    - ko-KR

ft:publication_title :

    - 호주 API 참조

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# 에이전트 클라이언트 수집기 API

# 에이전트 클라이언트 수집기 API {#ariaid-title1}

* 릴리스 버전: Australia
* 
* 업데이트 날짜 2026년 03월 12일
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 소요 시간: 110분

에이전트 클라이언트 수집기 API는 사용 가능한 에이전트에 대한 작업을 관리하고 정책을 관리하는 엔드포인트를 제공합니다.
이 API에는 프레임워크(sn_agent) 스토어 애플리케이션이 필요 에이전트 클라이언트 수집기 하며 `sn_agent` 네임스페이스 내에서 제공됩니다. 이 API의 엔드포인트에는 agent_client_collector_admin 역할이 필요합니다. 자세한 내용은 [에이전트 클라이언트 수집기를](https://www.servicenow.com/docs/access?context=acc-landing-page&version=australia&pubname=australia-it-operations-management&ft:locale=en-US) 참조하십시오.

에이전트 관리 엔드포인트
:
    * 하나 이상의 에이전트에 대한 광범위한 정보를 가져옵니다. 이러한 엔드포인트는 agent_client_collector_user 역할이 있는 사용자도 액세스할 수 있습니다.
      * [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-agent_id "지정된 에이전트의 정보를 가져옵니다.")
      * [GET /에이전트/목록](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-list "관련 정보가 있는 에이전트 목록을 가져옵니다.")
      {#agnt_clnt_cll-api__ul_tsy_mkq_dpb}
    * 요청을 제출하여 에이전트 로그를 가져오고 요청 진행률에 대한 정보를 검색합니다.
      * [GET /agents/{agent_id}/log](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-log "활성/작동 중인 상태인 지정된 에이전트의 로그를 요청합니다.")
      * [GET /agents/log/{request_id}/](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-data-off "업/활성 상태의 지정된 에이전트에 대해 데이터 수집을 비활성화합니다.")
      * [GET /agents/{agent_id}/data/on](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-data-on "업/활성 상태의 지정된 에이전트에 대해 데이터 수집을 활성화합니다.")
      {#agnt_clnt_cll-api__ul_z43_gkq_dpb}
    * [GET /agents/{agent_id}/restart](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-restart "지정된 에이전트를 활성/작동 상태로 다시 시작합니다.")로 에이전트를 다시 시작합니다.
    * [GET /agents/{agent_id}/discovery](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policies-list "게시되었거나 게시되지 않은 초안 상태에 있는 정책 목록을 가져옵니다.")를 사용하여 정책 및 상세 정보 목록을 가져옵니다. 이 엔드포인트에는 agent_client_collector_user 역할이 필요합니다.
       * 초안 상태의 정책을 업데이트하려면 업데이트 엔드포인트의 정책 목록에서 검색된 sys_ids 사용합니다.
       * 게시됨 또는 게시됨\* 상태의 정책을 업데이트하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policy-sbox-fr "게시된 정책의 샌드박스 사본을 가져오고 정책 상세 정보를 제공합니다.")를 사용하여 편집 가능한 샌드박스 복사본을 가져옵니다. 이 응답의 sys_ids 업데이트 엔드포인트를 사용하여 속성을 수정하려면 사용합니다.
       {#agnt_clnt_cll-api__ul_mtj_whk_fpb}
    2. 업데이트 엔드포인트를 사용하여 정책 상세 정보를 수정합니다.
       * [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-policy "정책의 샌드박스 사본을 업데이트합니다.")
       * [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check-id "선택한 정책 검사를 업데이트합니다.")
       * [게시 /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check_param "선택한 정책 검사 매개변수를 업데이트합니다.")
       * [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policy-act "게시된 정책을 활성화합니다.")
    * [GET /agents/policy/deactivate/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policy-deact "게시된 정책을 비활성화합니다.")
    {#agnt_clnt_cll-api__ul_glm_flk_fpb}

## 에이전트 클라이언트 수집기 - GET /agents/{agent_id} {#ariaid-title2}

지정된 에이전트의 정보를 가져옵니다.

### URL 형식

/api/sn_agent/agents/{agent_id}

### 지원되는 요청 매개변수

{#agnt_clnt_cll-GET-agent_id__entry__2}

| 이름 | 설명 |
|-|-|
| agent_id | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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 | 이 에이전트가 다른 에이전트와 중복되는지 여부를 나타내는 플래그입니다. 주어진 호스트에는 에이전트가 하나만 있어야 합니다. 가능한 값: * true: 에이전트가 다른 에이전트 ID를 가진 Alive/Up 에이전트와 동일한 호스트를 가지고 있습니다. 중복 항목 끄기 또는 제거 * false: 이 에이전트에는 Alive/Up 상태의 중복이 없습니다. {#agnt_clnt_cll-GET-agent_id__ul_b34_ffl_bpb} 데이터 유형: 부울 |
| is_restart_enabled | 다시 시작을 사용할 수 있는지 여부를 나타내는 플래그입니다. 에이전트 다시 시작을 구성할 수 없습니다. OS 및 에이전트가 실행 중인 OS 버전에 따라 다릅니다. 가능한 값: * true: 이 에이전트에 대해 다시 시작이 활성화되었습니다. * 아니오: 이 에이전트에 대한 재시작이 비활성화되었습니다. {#agnt_clnt_cll-GET-agent_id__ul_bvp_dfl_bpb} 데이터 유형: 부울 |
| 이름 | 에이전트의 이름입니다. 데이터 유형: 문자열 |
| number_of_running_checks | 에이전트가 실행하도록 예약된 검사 수입니다. 이러한 검사는 이 에이전트를 실행하도록 예약된 정책의 일부입니다. 데이터 유형: 숫자 |
| 상태 | 에이전트의 상태입니다. 가능한 값: * 0: 활성/사용 중 - 에이전트가 활성 상태입니다. * 1: 경고 -- 에이전트가 지난 몇 분 동안 연결 유지 메시지를 받지 못했습니다. * 2: 다운 -- 에이전트가 오랫동안 연결 유지 메시지를 받지 못했습니다. * 3: 다시 시작 -- 에이전트가 다시 시작됩니다. {#agnt_clnt_cll-GET-agent_id__ul_adg_ffp_bpb} 데이터 유형: 숫자 |
| up_since | 에이전트의 상태가 활성/작동 상태가 된 이후의 UTC 시간입니다. 값은 [GlideDateTime](https://servicenow-prod.fluidtopics.net/fpVGOlVCBMRuW84vxoNBIw#c_GlideDateTimeScoped "범위가 지정된 GlideDateTime 클래스는 GlideDateTime 객체에 대한 작업을 수행하기 위한 메서드를 제공합니다.") 형식입니다. 데이터 유형: 문자열 |
| 버전 | 에이전트 버전 에이전트 클라이언트 수집기 이 실행 중입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

다음 예시에서는 에이전트 상세 정보를 가져오는 방법을 보여줍니다.

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

출력:

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

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<agent_id>/data/off" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

출력:

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

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<agent_id>/data/on" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

출력:

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

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#agnt_clnt_cll-GET-discovery__table_owl_zyc_z4b}  

### cURL 요청

다음 예는 활성/작동 상태인 에이전트에서 검색을 실행하는 방법을 보여줍니다.

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

출력:

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

## 에이전트 클라이언트 수집기 - 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: 검사 매개변수 상세 정보를 반환합니다. * 아니오: 검사 매개변수 상세 정보를 반환하지 않습니다. {#agnt_clnt_cll-GET-check_defs-id__ul_pv3_gqc_wqb} 데이터 유형: 부울 기본값: false |
[표 27. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 속성 | 설명 |
|-|-|
| 확인 | 지정된 검사 정의의 상세 정보입니다. { "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 } |
| 배경 | 이 검사 정의가 백그라운드 확인인지 여부를 나타내는 플래그입니다. 백그라운드 검사는 에이전트가 실행을 시작하고 실행이 완료될 때까지 기다리지 않는 검사입니다. 유효한 값은 다음과 같습니다. * true: 이 확인 정의는 백그라운드 확인입니다. * false: 이 확인 정의는 백그라운드 확인이 아닙니다. {#agnt_clnt_cll-GET-check_defs-id__ul_ypb_5ps_5qb} 데이터 유형: 부울 |
| check_group | 이 검사 정의에 지정된 그룹입니다. 데이터 유형: 문자열 |
| check_type | 검사 유형입니다. 가능한 값: * 이벤트 -- 검사 결과가 Event Management 이벤트로 변환됩니다. * 메트릭 -- 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-GET-check_defs-id__ul_gtr_kfb_wqb} 데이터 유형: 문자열 |
| command | 실행할 명령입니다.에이전트 클라이언트 수집기 데이터 유형: 문자열 |
| 오류 | 오류가 있는 경우 메시지입니다. 그렇지 않으면 null입니다. 데이터 유형: 문자열 |
| 이름 | 검사의 이름입니다. 데이터 유형: 문자열 |
| 매개변수 | 검사 정의와 연결된 매개변수 정의의 목록입니다. 이러한 결과는 매개변수가 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입니다. 데이터 유형: 문자열 |
| 플러그인 | 이 검사와 관련된 [에이전트 클라이언트 수집기 플러그인 목록입니다](https://www.servicenow.com/docs/access?context=acc-assets&version=australia&pubname=australia-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입니다. 데이터 유형: 문자열 |
| 시간 제한 | 시간 제한(초). 데이터 유형: 숫자 |
[ ]

### 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"
        }
      ]
    }

## 에이전트 클라이언트 수집기 - 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=australia&pubname=australia-platform-user-interface&ft:locale=en-US) 입니다. 시스템에서 필터링되지 않은 검사 정의 목록에는 null을 사용합니다. 데이터 유형: 문자열 |
| x-include-check-params | 기존 검사 매개변수 상세 정보가 반환되는지 여부를 나타내는 플래그입니다. 각 표준 및 보안 검사 매개변수에 대한 정보는 JSON 객체에 포함되어 있습니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수 상세 정보를 반환합니다. * 아니오: 검사 매개변수 상세 정보를 반환하지 않습니다. {#agnt_clnt_cll-GET-check_defs-list__ul_pv3_gqc_wqb} 데이터 유형: 부울 기본값: false |
| X-리미트 | 반환되는 기록 수를 제한합니다. 기본값을 사용하려면 null로 설정합니다. 데이터 유형: 숫자 기본값: 20,000 |
[표 33. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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 } ] 데이터 유형: 배열 |
| 배경 | 이 검사 정의가 백그라운드 확인인지 여부를 나타내는 플래그입니다. 백그라운드 검사는 에이전트가 실행을 시작하고 실행이 완료될 때까지 기다리지 않는 검사입니다. 유효한 값은 다음과 같습니다. * true: 이 확인 정의는 백그라운드 확인입니다. * false: 이 확인 정의는 백그라운드 확인이 아닙니다. {#agnt_clnt_cll-GET-check_defs-list__ul_ypb_5ps_5qb} 데이터 유형: 부울 |
| check_group | 이 검사 정의에 지정된 그룹입니다. 데이터 유형: 문자열 |
| check_type | 검사 유형입니다. 가능한 값: * 이벤트 -- 검사 결과가 Event Management 이벤트로 변환됩니다. * 메트릭 -- 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-GET-check_defs-list__ul_gtr_kfb_wqb} 데이터 유형: 문자열 |
| command | 실행할 명령입니다.에이전트 클라이언트 수집기 데이터 유형: 문자열 |
| 이름 | 검사의 이름입니다. 데이터 유형: 문자열 |
| 매개변수 | 검사 정의와 연결된 매개변수 정의의 목록입니다. 이러한 결과는 매개변수가 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=australia&pubname=australia-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입니다. 데이터 유형: 문자열 |
| 시간 제한 | 시간 제한(초). 데이터 유형: 숫자 |
[ ]

### cURL 요청

다음 예제에서는 매개변수 값이 있는 두 검사 정의 목록을 검색하는 방법을 보여줍니다.

    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": []
        }
      ]
    }

## 에이전트 클라이언트 수집기 - 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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'

## 에이전트 클라이언트 수집기 - 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 상태 | 요청 상태입니다. 가능한 값: * 완료 -- 검사에 성공했습니다. * 실패 -- 검사에 실패했습니다. 자세한 내용은 오류 메시지를 참조하십시오. * mid_flow -- 요청 출력이 MID 서버에서 처리되고 있습니다. * 처리 중 -- 검사가 진행 중입니다. * 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'

## 에이전트 클라이언트 수집기 - 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 속성 | 설명 |
|-|-|
| 상태 | 테스트 결과의 상태입니다. 가능한 값: * 0: 보류 중 * 1: 진행 중 * 2: 완료 * 3: 지정된 ID에 테스트 결과 없음 {#agnt_clnt_cll-GET-exec-test-result__ul_yyq_4bq_5qb} 데이터 유형: 문자열 |
| 출력 | 상태를 설명하는 출력입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

다음 예제에서는 완료된 테스트 검사 요청의 결과 상태를 가져오는 방법을 보여줍니다.

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

## 에이전트 클라이언트 수집기 - GET /agents/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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#agnt_clnt_cll-GET-list__entry__14}{#agnt_clnt_cll-GET-list__accept-JSON-only-entry-RESTAPI}

| 머리글 | 설명 |
|-|-|
| 수용 | 응답 본문의 데이터 형식입니다. application/json만 지원합니다. |
| x-enc-query | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_agent\] 테이블에서 표준 Glide 형식으로 인코딩된 쿼리입니다. [인코딩된 쿼리 문자열을 참조하세요.](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=australia&pubname=australia-platform-user-interface&ft:locale=en-US) |
| X-리미트 | 결과를 에이전트의 최대 수로 제한합니다. 필요하지 않은 경우 둘 다에 null 또는 undefined를 사용합니다. 기본값/최대값: 20,000 데이터 유형: 숫자 |
[표 58. 요청 헤더]

{#agnt_clnt_cll-GET-list__entry__22}

| 머리글 | 설명 |
|-|-|
| 안 함 |   |
[표 59. 응답 헤더]

### 상태 코드

이 HTTP 작업에 적용되는 상태 코드는 다음과 같습니다. REST API에 사용되는 가능한 상태 코드 목록은 [REST API HTTP 응답 코드를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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 | 이 에이전트가 다른 에이전트와 중복되는지 여부를 나타내는 플래그입니다. 주어진 호스트에는 에이전트가 하나만 있어야 합니다. 가능한 값: * true: 에이전트가 다른 에이전트 ID를 가진 Alive/Up 에이전트와 동일한 호스트를 가지고 있습니다. 중복 항목 끄기 또는 제거 * false: 이 에이전트에는 Alive/Up 상태의 중복이 없습니다. {#agnt_clnt_cll-GET-list__ul_b34_ffl_bpb} 데이터 유형: 부울 |
| is_restart_enabled | 다시 시작을 사용할 수 있는지 여부를 나타내는 플래그입니다. 에이전트 다시 시작을 구성할 수 없습니다. OS 및 에이전트가 실행 중인 OS 버전에 따라 다릅니다. 가능한 값: * true: 이 에이전트에 대해 다시 시작이 활성화되었습니다. * 아니오: 이 에이전트에 대한 재시작이 비활성화되었습니다. {#agnt_clnt_cll-GET-list__ul_bvp_dfl_bpb} 데이터 유형: 부울 |
| 이름 | 에이전트의 이름입니다. 데이터 유형: 문자열 |
| number_of_running_checks | 에이전트가 실행하도록 예약된 검사 수입니다. 이러한 검사는 이 에이전트를 실행하도록 예약된 정책의 일부입니다. 데이터 유형: 숫자 |
| 상태 | 에이전트의 상태입니다. 가능한 값: * 0: 활성/사용 중 - 에이전트가 활성 상태입니다. * 1: 경고 -- 에이전트가 지난 몇 분 동안 연결 유지 메시지를 받지 못했습니다. * 2: 다운 -- 에이전트가 오랫동안 연결 유지 메시지를 받지 못했습니다. * 3: 다시 시작 -- 에이전트가 다시 시작됩니다. {#agnt_clnt_cll-GET-list__ul_adg_ffp_bpb} 데이터 유형: 숫자 |
| up_since | 에이전트의 상태가 활성/작동 상태가 된 이후의 UTC 시간입니다. 값은 [GlideDateTime](https://servicenow-prod.fluidtopics.net/fpVGOlVCBMRuW84vxoNBIw#c_GlideDateTimeScoped "범위가 지정된 GlideDateTime 클래스는 GlideDateTime 객체에 대한 작업을 수행하기 위한 메서드를 제공합니다.") 형식입니다. 데이터 유형: 문자열 |
| 버전 | 에이전트 버전 에이전트 클라이언트 수집기 이 실행 중입니다. 데이터 유형: 문자열 |
[ ]

### 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'

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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 | 에이전트 클라이언트 수집기 요청\[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/<sys_id>/log" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

출력:

    "request_id": "<sys_id>"

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 요청\[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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 속성 | 설명 |
|-|-|
| 출력 | 상태를 설명하는 정보입니다. |
[ ]

### cURL 요청

다음 예제에서는 요청 ID를 사용하여 Grab 로그 요청의 상태를 가져오는 방법을 보여줍니다.

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

출력:

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

## 에이전트 클라이언트 수집기 - 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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=australia&pubname=australia-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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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=australia&pubname=australia-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" } ] } 데이터 유형: 배열 |
| 정책.활성 | 정책이 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 정책이 활성 상태입니다. * false: 정책이 활성화되어 있지 않습니다. {#agnt_clnt_cll-GET-policies-list__ul_qr2_g3x_dpb} 데이터 유형: 부울 |
| policies.agent_ids | 에이전트의 고유 ID입니다. 이러한 결과는 헤더 매개변수가 X-Include-Checks-And-Agents true로 설정된 경우에만 표시됩니다. 에이전트에 대한 자세한 정보를 보려면 [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-agent_id "지정된 에이전트의 정보를 가져옵니다.") 엔드포인트에서 ID를 실행합니다. 데이터 유형: 문자열 테이블: 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_agent\] 테이블의 에이전트 ID 열입니다. |
| 정책.검사 | 검사 인스턴스 \[sn_agent_check\] 테이블에 나열된 검사를 정의하는 객체의 목록입니다. 이러한 결과는 OR X-Include-Check-Params 헤더 매개변수가 X-Include-Checks-And-Agents 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 | 모니터링 옵션을 지정하는 검사 유형입니다. 가능한 값: * 검색: 에이전트와 관련된 CI를 찾는지 확인합니다. * 이벤트: 검사 결과가 이벤트 관리 이벤트로 변환됩니다. * 메트릭: 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-GET-policies-list__ul_pgd_42t_2pb} 데이터 유형: 문자열 |
| policies.checks.command | 실행할 명령입니다.에이전트 클라이언트 수집기 템플릿 또는 모니터링된 CI에서 가져온 매개변수입니다. 주: 예일 경우 auto_generate 이 속성은 객체에 parameters 나열된 활성 매개변수의 프리픽스와 플래그로 자동으로 채워집니다. 데이터 유형: 문자열 |
| policies.checks.command_prefix | 속성이 auto_generate 예일 경우 이 명령은 자동 생성에 사용됩니다. 프리픽스는 스크립트 이름과 같이 정적(변경되지 않는) 명령의 일부로 구성됩니다. 데이터 유형: 문자열 |
| policies.checks.event_status_change_threshold | 새 이벤트를 전송하기 전에 검사 응답 상태가 나타나야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 확인에서 오류로 변경되는 검사는 상태 변경이 세 번 연속 발생한 후 오류 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| policies.checks.event_status_repair_threshold | 이전 이벤트를 종결하기 위해 검사 응답 상태가 개선되어야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 오류에서 정상으로 변경되는 검사는 이전 이벤트를 종결하고 상태 변경이 세 번 연속 발생한 후 정상 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| policies.checks.interval | 검사 실행 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 데이터 유형: 숫자 |
| policies.checks.name | 검사의 이름입니다. 데이터 유형: 문자열 |
| policies.checks.sys_id | 검사의 Sys_id입니다. 데이터 유형: 문자열 테이블: 검사 인스턴스 \[sn_agent_check\] |
| policies.checks.timeout | 출력이 반환되지 않을 때 검사 실행이 중지되기까지의 시간(초)입니다. 예를 들어 값이 60이면 검사 실행이 60초 동안 값을 반환하지 않으면 실행이 중지됩니다. 데이터 유형: 문자열 |
| policies.cred_alias | 자격 증명 이름입니다. 데이터 유형: 문자열 테이블: 자격 증명 \[discovery_credentials\] |
| policies.credential_alias | 자격 증명 별칭의 Sys_id입니다. 데이터 유형: 문자열 테이블: 연결 및 자격 증명 별칭 \[sys_alias\] |
| policies.filter | 지정된 기준만 모니터링하도록 정책 검사를 제한하는 필터입니다. 데이터 유형: 문자열 |
| 정책.간격 | 정책 검사 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 주: 속성 값은 checks.interval 이 필드에 구성된 값을 재정의합니다. 데이터 유형: 숫자 |
| policies.monitored_ci_group | 정책과 연결된 [CMDB 그룹](https://www.servicenow.com/docs/access?context=cmdb-groups&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US) 의 이름입니다. 이 필드는 속성 값이 monitored_ci_type_group 예인 경우에만 적용됩니다. 데이터 유형: 문자열 테이블: CMDB 그룹 \[cmdb_group\] |
| policies.monitored_ci_script | CI를 모니터링하기 위한 스크립트입니다. 이 필드는 속성 값이 policies.monitored_ci_type_script 예인 경우에만 적용됩니다. 데이터 유형: 문자열 |
| 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 | 정책이 게시되었는지 여부를 나타냅니다. 가능한 값: * 초안: 정책이 게시되지 않았으며 업데이트 엔드포인트를 사용하여 편집할 수 있습니다. * 게시됨: 정책이 게시되었습니다. 초안(샌드박스 복사본)과 게시된 복사본이 동일합니다. * 게시됨\*: 정책이 게시되었지만 초안 복사본(샌드박스 뷰)의 변경 내용을 게시된 복사본에서 찾을 수 없습니다. {#agnt_clnt_cll-GET-policies-list__ul_d3k_qzm_fpb} 데이터 유형: 문자열 |
| policies.sys_id | 정책의 Sys_id입니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
| policies.sys_updated_on | 정책이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| policies.table | 정책의 모니터링되는 CI 유형 필드입니다. 이 필드는 true인 경우에만 monitored_ci_type_filter 적용됩니다. 데이터 유형: 문자열 |
| 정책.매개변수 | 검사 매개변수 정보를 포함하는 객체의 목록입니다. 이러한 결과는 헤더 매개변수가 X-Include-Check-Params true로 설정된 경우에만 표시됩니다. 데이터 유형: 객체 배열 "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] 테이블: 검사 매개변수 \[sn_agent_check_param\] |
| policies.params.active | 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수가 활성 상태입니다. * false: 검사 매개변수가 비활성 상태입니다. {#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 | 매개변수의 Sys_id입니다. 데이터 유형: 문자열 테이블: 검사 매개변수 \[sn_agent_check_param\] |
| 정책.매개변수.값 | 매개변수의 값입니다. 데이터 유형: 문자열 |
| policies.params.value_required | 값 속성에서 제공하는 정보가 필수인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: value 속성이 필요합니다. * false: value 속성이 null이거나 필요하지 않습니다. {#agnt_clnt_cll-GET-policies-list__ul_ug3_3jv_2pb} 데이터 유형: 부울 |
| policies.secure_params | 검사 보안 매개변수 정보를 포함하는 객체의 목록입니다. 자세한 내용은 [검사에 대한 보안 매개변수 생성을](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=australia&pubname=australia-it-operations-management&ft:locale=en-US) 참조하세요. 이러한 결과는 헤더 매개변수가 X-Include-Check-Params true로 설정된 경우에만 표시됩니다. 데이터 유형: 객체 배열 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] 테이블: 보안 매개변수 확인 \[sn_agent_check_secure_param\] |
| policies.secure_params.active | 보안 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 보안 매개변수가 활성 상태입니다. * false: 검사 보안 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-GET-policies-list__ul_xwy_vfv_2pb} 데이터 유형: 부울 |
| policies.secure_params.name | 보안 매개변수의 이름입니다. 데이터 유형: 문자열 |
| policies.secure_params.order | 매개변수가 검사 명령/스크립트로 전송되는 순서입니다. 데이터 유형: 숫자 |
| policies.secure_params.sys_id | 기록의 Sys_id입니다. 데이터 유형: 문자열 테이블: 보안 매개변수 검사 \[sn_agent_check_secure_param\] |
[표 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"
        }
      ]
    }

## 에이전트 클라이언트 수집기 - GET /agents/policy/activate/{policy_id} {#ariaid-title15}

게시된 정책을 활성화합니다.
게시된 정책 목록의 경우 [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policies-list "게시되었거나 게시되지 않은 초안 상태에 있는 정책 목록을 가져옵니다.")를 사용하십시오. 이 엔드포인트는 정책 속성 publish_status 값이 `게시됨` 또는 `게시됨*`인 sys_ids만 지원합니다.

### 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 | 게시된 정책의 Sys_id입니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
[표 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 머리글 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#agnt_clnt_cll-GET-policy-act__table_h5l_bgs_2pb}  

### cURL 요청

다음 예시에서는 정책을 활성화하는 방법을 보여줍니다.

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

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - GET /agents/policy/deactivate/{policy_id} {#ariaid-title16}

게시된 정책을 비활성화합니다.
게시된 정책 목록의 경우 [GET /agents/policies/list](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policies-list "게시되었거나 게시되지 않은 초안 상태에 있는 정책 목록을 가져옵니다.")를 사용하십시오. 이 엔드포인트는 정책 속성 publish_status 값이 `게시됨` 또는 `게시됨*`인 sys_ids만 지원합니다.

### 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 | 게시된 정책의 Sys_id입니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
[표 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 머리글 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<sys_id>" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username' : 'password'

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - GET /agents/policy/publish/{policy_id} {#ariaid-title17}

초안 정책을 게시합니다.
다음 엔드포인트 중 하나를 사용하여 게시하기 전에 초안 또는 샌드박스 복사본을 수정합니다.

* [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-policy "정책의 샌드박스 사본을 업데이트합니다.")
* [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check-id "선택한 정책 검사를 업데이트합니다.")
* [게시 /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check_param "선택한 정책 검사 매개변수를 업데이트합니다.")
* [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policies-list "게시되었거나 게시되지 않은 초안 상태에 있는 정책 목록을 가져옵니다.")를 사용하십시오. * 정책의 샌드박스 사본을 검색하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 머리글 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#agnt_clnt_cll-GET-policy-publish__table_h5l_bgs_2pb}  

### cURL 요청

다음 예시에서는 정책을 게시하는 방법을 보여줍니다.

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

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - GET /agents/policy/sandbox_from_published/{policy_id} {#ariaid-title18}

게시된 정책의 샌드박스 사본을 가져오고 정책 상세 정보를 제공합니다.
샌드박스 복사본을 사용하여 정책을 업데이트하고 게시합니다. 응답 본문의 sys_ids 사용하여 다음 엔드포인트로 작업할 수 있습니다.

* [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-policy "정책의 샌드박스 사본을 업데이트합니다.")
* [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check-id "선택한 정책 검사를 업데이트합니다.")
* [게시 /agents/update/check_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check_param "선택한 정책 검사 매개변수를 업데이트합니다.")
* [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-policies-list "게시되었거나 게시되지 않은 초안 상태에 있는 정책 목록을 가져옵니다.")를 사용하십시오. 이 엔드포인트는 정책 속성 publish_status 값이 `게시됨` 또는 `게시됨*`인 sys_ids만 지원합니다.

### 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 | 게시된 정책의 Sys_id입니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
[표 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 속성 | 설명 |
|-|-|
| \<Object\> | 정책과 연결된 샌드박스 사본의 확장된 상세 정보입니다. 정책에 대한 자세한 내용은 [기본 검사 및 정책을 참조하십시오.](https://www.servicenow.com/docs/access?context=agent-policies-checks&version=australia&pubname=australia-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" } |
| 활성 | 정책이 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 정책이 활성 상태입니다. * false: 정책이 활성화되어 있지 않습니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_qr2_g3x_dpb} 데이터 유형: 부울 |
| agent_ids | 에이전트의 고유 ID입니다. 이러한 결과는 헤더 매개변수가 X-Include-Checks-And-Agents true로 설정된 경우에만 표시됩니다. 에이전트에 대한 자세한 정보를 보려면 [GET /agents/{agent_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-GET-agent_id "지정된 에이전트의 정보를 가져옵니다.") 엔드포인트에서 ID를 실행합니다. 데이터 유형: 문자열 테이블: 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_agent\] 테이블의 에이전트 ID 열입니다. |
| 검사 | 검사 인스턴스 \[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 | 모니터링 옵션을 지정하는 검사 유형입니다. 가능한 값: * 검색: 에이전트와 관련된 CI를 찾는지 확인합니다. * 이벤트: 검사 결과가 이벤트 관리 이벤트로 변환됩니다. * 메트릭: 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_pgd_42t_2pb} 데이터 유형: 문자열 |
| checks.command | 실행할 명령입니다.에이전트 클라이언트 수집기 템플릿 또는 모니터링된 CI에서 가져온 매개변수입니다. 주: 예일 경우 auto_generate 이 속성은 객체에 parameters 나열된 활성 매개변수의 프리픽스와 플래그로 자동으로 채워집니다. 데이터 유형: 문자열 |
| checks.command_prefix | 속성이 auto_generate 예일 경우 이 명령은 자동 생성에 사용됩니다. 프리픽스는 스크립트 이름과 같이 정적(변경되지 않는) 명령의 일부로 구성됩니다. 데이터 유형: 문자열 |
| checks.event_status_change_threshold | 새 이벤트를 전송하기 전에 검사 응답 상태가 나타나야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 확인에서 오류로 변경되는 검사는 상태 변경이 세 번 연속 발생한 후 오류 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| checks.event_status_repair_threshold | 이전 이벤트를 종결하기 위해 검사 응답 상태가 개선되어야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 오류에서 정상으로 변경되는 검사는 이전 이벤트를 종결하고 상태 변경이 세 번 연속 발생한 후 정상 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| checks.interval | 검사 실행 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 데이터 유형: 숫자 |
| checks.name | 검사의 이름입니다. 데이터 유형: 문자열 |
| checks.sys_id | 검사의 Sys_id입니다. [POST /agents/update/check/{check_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check-id "선택한 정책 검사를 업데이트합니다.") 엔드포인트는 이 값을 사용하여 샌드박스 복사본을 업데이트합니다. 데이터 유형: 문자열 테이블: 검사 인스턴스 \[sn_agent_check\] |
| checks.timeout | 출력이 반환되지 않을 때 검사 실행이 중지되기까지의 시간(초)입니다. 예를 들어 값이 60이면 검사 실행이 60초 동안 값을 반환하지 않으면 실행이 중지됩니다. 데이터 유형: 문자열 |
| cred_alias | 자격 증명 이름입니다. 데이터 유형: 문자열 테이블: 자격 증명 \[discovery_credentials\] |
| credential_alias | 자격 증명 별칭의 Sys_id입니다. 데이터 유형: 문자열 테이블: 연결 및 자격 증명 별칭 \[sys_alias\] |
| 필터 | 지정된 기준만 모니터링하도록 정책 검사를 제한하는 필터입니다. 데이터 유형: 문자열 |
| 간격 | 정책 검사 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 주: 속성 값은 checks.interval 이 필드에 구성된 값을 재정의합니다. 데이터 유형: 숫자 |
| monitored_ci_group | 정책과 연결된 [CMDB 그룹](https://www.servicenow.com/docs/access?context=cmdb-groups&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US) 의 이름입니다. 이 필드는 속성 값이 monitored_ci_type_group 예인 경우에만 적용됩니다. 데이터 유형: 문자열 테이블: CMDB 그룹 \[cmdb_group\] |
| monitored_ci_script | CI를 모니터링하기 위한 스크립트입니다. 이 필드는 속성 값이 policies.monitored_ci_type_script 예인 경우에만 적용됩니다. 데이터 유형: 문자열 |
| 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} 데이터 유형: 부울 |
| 이름 | 정책 이름 데이터 유형: 문자열 |
| publish_status | 정책이 게시되었는지 여부를 나타냅니다. 가능한 값: * 초안: 정책이 게시되지 않았으며 업데이트 엔드포인트를 사용하여 편집할 수 있습니다. * 게시됨: 정책이 게시되었습니다. 초안(샌드박스 복사본)과 게시된 복사본이 동일합니다. * 게시됨\*: 정책이 게시되었지만 초안 복사본(샌드박스 뷰)의 변경 내용을 게시된 복사본에서 찾을 수 없습니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_d3k_qzm_fpb} 데이터 유형: 문자열 |
| 매개변수 | 검사 매개변수 정보를 포함하는 객체의 목록입니다. 이러한 결과는 헤더 매개변수가 X-Include-Check-Params true로 설정된 경우에만 표시됩니다. 데이터 유형: 객체 배열 "params": [ { "active": Boolean, "flag": "String", "mandatory: Boolean, "name": "String", "sys_id": "String", "value": "String", "value_required": Boolean } ] 테이블: 검사 매개변수 \[sn_agent_check_param\] |
| params.active | 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수가 활성 상태입니다. * false: 검사 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_u2x_5fv_2pb} 데이터 유형: 부울 |
| params.플래그 | 검사 발동 중에 사용할 매개변수 플래그입니다. 데이터 유형: 문자열 |
| 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/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check_param "선택한 정책 검사 매개변수를 업데이트합니다.") 엔드포인트는 이 값을 사용하여 샌드박스 복사본을 업데이트합니다. 데이터 유형: 문자열 |
| 매개변수.값 | 매개변수의 값입니다. 데이터 유형: 문자열 |
| params.value_required | 값 속성에서 제공하는 정보가 필수인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: value 속성이 필요합니다. * false: value 속성이 null이거나 필요하지 않습니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_ug3_3jv_2pb} 데이터 유형: 부울 |
| secure_params | 검사 보안 매개변수 정보를 포함하는 객체의 목록입니다. 자세한 내용은 [검사에 대한 보안 매개변수 생성을](https://www.servicenow.com/docs/access?context=acc-create-secure-params&version=australia&pubname=australia-it-operations-management&ft:locale=en-US) 참조하세요. 이러한 결과는 헤더 매개변수가 X-Include-Check-Params true로 설정된 경우에만 표시됩니다. 데이터 유형: 객체 배열 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] 테이블: 보안 매개변수 확인 \[sn_agent_check_secure_param\] |
| secure_params.active | 보안 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 보안 매개변수가 활성 상태입니다. * false: 검사 보안 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-GET-policy-sbox-fr__ul_xwy_vfv_2pb} 데이터 유형: 부울 |
| secure_params.name | 보안 매개변수의 이름입니다. 데이터 유형: 문자열 |
| secure_params.order | 매개변수가 검사 명령/스크립트로 전송되는 순서입니다. 데이터 유형: 숫자 |
| secure_params.sys_id | 기록의 Sys_id입니다. [POST /agents/update/check_secure_param/{param_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-check_secure "선택한 정책 검사 보안 매개변수를 업데이트합니다.") 엔드포인트는 이 값을 사용하여 샌드박스 복사본을 업데이트합니다. 데이터 유형: 문자열 테이블: 보안 매개변수 검사 \[sn_agent_check_secure_param\] |
| sys_id | 정책의 Sys_id입니다. [POST /agents/update/policy/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#agnt_clnt_cll-POST-update-policy "정책의 샌드박스 사본을 업데이트합니다.") 엔드포인트는 이 값을 사용하여 샌드박스 복사본을 업데이트합니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
| sys_updated_on | 정책이 마지막으로 업데이트된 날짜 및 시간입니다. 데이터 유형: 문자열 |
| 테이블 | 정책의 모니터링되는 CI 유형 필드입니다. 이 필드는 true인 경우에만 monitored_ci_type_filter 적용됩니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

다음은 Docker 컨테이너 메트릭 정책에 대한 정보를 가져오는 방법을 보여줍니다.

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

출력:

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

## 에이전트 클라이언트 수집기 - 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 | 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<agent_id>/restart" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

출력:

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

## 에이전트 클라이언트 수집기 - 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": { "<parameter name>": "String" } 데이터 유형: 객체 |
| 우선순위 | ECC 큐에 설정할 요청의 우선순위입니다. 가능한 값: * 0: 대화형 * 1: 긴급 * 2: 표준 {#agnt_clnt_cll-POST-check-def-run__ul_bkf_hnq_wqb} 데이터 유형: 숫자 |
| 쿼리 | 속성에 지정된 테이블에서 GlideRecord를 검색하기 위한 인코딩된 쿼리입니다 table . 데이터 유형: 문자열 |
| 테이블 | 이 백그라운드 확인에 대한 cmdb_ci 테이블의 이름입니다. 데이터 유형: 문자열 |
| 시간 제한 | 요청의 시간 제한 값(초)입니다. 데이터 유형: 숫자 |
[표 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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"
    }

## 에이전트 클라이언트 수집기 - 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

## 에이전트 클라이언트 수집기 - 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입니다. 이 값은 에이전트 클라이언트 수집기 \[sn_agent_cmdb_ci_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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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입니다. |
[ ]

## 에이전트 클라이언트 수집기 - POST /agents/update/check/{check_id} {#ariaid-title23}

선택한 정책 검사를 업데이트합니다.
정책 샌드박스 복사본의 속성을 검색하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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}

| 이름 | 설명 |
|-|-|
| 활성 | 정책 검사가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * 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 | 모니터링 옵션을 지정하는 검사 유형입니다. 가능한 값: * 검색: 에이전트와 관련된 CI를 찾는지 확인합니다. * 이벤트: 검사 결과가 이벤트 관리 이벤트로 변환됩니다. * 메트릭: 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-POST-update-check-id__ul_pgd_42t_2pb} 데이터 유형: 문자열 |
| command | 실행할 명령입니다.에이전트 클라이언트 수집기 템플릿 또는 모니터링된 CI에서 가져온 매개변수입니다. 주: 예일 경우 auto_generate 이 속성은 객체에 parameters 나열된 활성 매개변수의 프리픽스와 플래그로 자동으로 채워집니다. 데이터 유형: 문자열 |
| command_prefix | 속성이 auto_generate 예일 경우 이 명령은 자동 생성에 사용됩니다. 프리픽스는 스크립트 이름과 같이 정적(변경되지 않는) 명령의 일부로 구성됩니다. 데이터 유형: 문자열 |
| event_status_change_threshold | 새 이벤트를 전송하기 전에 검사 응답 상태가 나타나야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 확인에서 오류로 변경되는 검사는 상태 변경이 세 번 연속 발생한 후 오류 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| event_status_repair_threshold | 이전 이벤트를 종결하기 위해 검사 응답 상태가 개선되어야 하는 연속 횟수입니다. 설정되지 않은 경우 null을 반환합니다. 예를 들어, 이 값이 3이면 응답 상태가 오류에서 정상으로 변경되는 검사는 이전 이벤트를 종결하고 상태 변경이 세 번 연속 발생한 후 정상 상태인 새 이벤트를 생성합니다. 데이터 유형: 숫자 |
| 간격 | 검사 실행 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 데이터 유형: 숫자 |
| 이름 | 검사의 이름입니다. 데이터 유형: 문자열 |
| 시간 제한 | 출력이 반환되지 않을 때 검사 실행이 중지되기까지의 시간(초)입니다. 예를 들어 값이 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<check_sys_id>" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
        \"event_status_change_threshold\" : \"2\",
        \"event_status_repair_threshold\" : \"1\"
    }" \
    --user 'username':'password'

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - POST /agents/update/check_def_params/{check_def_param_id} {#ariaid-title24}

지정된 검사 매개변수의 필드 값을 하나 이상 변경할 수 있습니다.

### 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 | 검사 매개변수의 Sys_id입니다. 데이터 유형: 문자열 테이블: 검사 매개변수 정의 \[sn_agent_check_param_def\] |
[표 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}

| 이름 | 설명 |
|-|-|
| 활성 | 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수가 활성 상태입니다. * false: 검사 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-POST-up-check-def-p__ul_pnb_jyc_wqb} 데이터 유형: 부울 |
| default_value | 이 검사 매개변수의 기본값을 지정합니다. 데이터 유형: 문자열 |
| 필수 | 검사 매개변수가 필수인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수가 필요합니다. * false: 검사 매개변수는 선택 사항입니다. {#agnt_clnt_cll-POST-up-check-def-p__ul_wtg_2zc_wqb} 데이터 유형: 부울 |
| 이름 | 검사 매개변수의 이름입니다. 데이터 유형: 문자열 |
[표 136. 요청 본문 매개변수(JSON)]

{#agnt_clnt_cll-POST-up-check-def-p__table_fhm_klr_wqb}  
주:  
검사 정의 필드 및 유형의 전체 목록은 데이터 사전을 참조하십시오.

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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"

## 에이전트 클라이언트 수집기 - POST /agents/update/check_def_secure_params/{check_def_secure_param_id} {#ariaid-title25}

지정된 검사 보안 매개변수의 필드 값을 하나 이상 변경할 수 있습니다.

### 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 | 보안 매개변수의 Sys_id입니다. 데이터 유형: 문자열 테이블: 보안 매개변수 정의 확인\[sn_agent_check_secure_param_def\] |
[표 140. 경로 매개변수]

{#agnt_clnt_cll-POST-up-check-def-sp__entry__6}

| 이름 | 설명 |
|-|-|
| 없음 |   |
[표 141. 쿼리 매개변수]

{#agnt_clnt_cll-POST-up-check-def-sp__entry__10}

| 이름 | 설명 |
|-|-|
| 활성 | 보안 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 보안 매개변수가 활성 상태입니다. * false: 보안 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-POST-up-check-def-sp__ul_g1b_3vc_wqb} 데이터 유형: 부울 |
| 이름 | 보안 매개변수의 이름입니다. 데이터 유형: 문자열 |
| 순서 | 매개변수가 검사 명령/스크립트로 전송되는 순서입니다. 데이터 유형: 문자열 |
[표 142. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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"

## 에이전트 클라이언트 수집기 - POST /agents/update/check_defs/{check_def_id} {#ariaid-title26}

지정된 검사 정의의 필드 값을 하나 이상 변경할 수 있습니다.

### 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}

| 이름 | 설명 |
|-|-|
| 활성 | 이 검사 정의가 활성 상태인지 여부를 나타냅니다. 유효한 값은 다음과 같습니다. * 0: 이 검사 정의가 비활성 상태입니다. * 1: 이 검사 정의가 활성 상태입니다. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gdc_4wj_wqb} 데이터 유형: 숫자 |
| 배경 | 이 검사 정의가 백그라운드 확인인지 여부를 나타내는 플래그입니다. 백그라운드 검사는 에이전트가 실행을 시작하고 실행이 완료될 때까지 기다리지 않는 검사입니다. 유효한 값은 다음과 같습니다. * true: 이 확인 정의는 백그라운드 확인입니다. * false: 이 확인 정의는 백그라운드 확인이 아닙니다. {#agnt_clnt_cll-POST-up-check-def-cd__ul_ypb_5ps_5qb} 데이터 유형: 부울 |
| check_group | 이 검사 정의에 지정된 그룹입니다. |
| check_type | 검사 유형입니다. 가능한 값: * 이벤트 -- 검사 결과가 Event Management 이벤트로 변환됩니다. * 메트릭 -- 검사 결과의 값이 메트릭으로 변환됩니다. {#agnt_clnt_cll-POST-up-check-def-cd__ul_gtr_kfb_wqb} 데이터 유형: 문자열 |
| command | 실행할 명령입니다.에이전트 클라이언트 수집기 데이터 유형: 문자열 |
| 이름 | 검사의 이름입니다. 데이터 유형: 문자열 |
| 매개변수 | 매개변수 이름 및 값의 맵입니다. 이러한 설정은 검사 정의의 매개변수 기록과 지정된 값을 재정의하는 데 사용할 수 있습니다. "params": { "<parameter name>": "String" } 데이터 유형: 객체 |
| 플러그인 | 목록 [에이전트 클라이언트 수집기 플러그인](https://www.servicenow.com/docs/access?context=acc-assets&version=australia&pubname=australia-it-operations-management&ft:locale=en-US) 이 검사와 연결됩니다. 데이터 유형: 배열 |
| proxy_valid | 검사 정의 정책이 프록시로 작동하도록 설정되었는지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 이 검사 정의 정책이 프록시로 작동하도록 설정됩니다. * false: 이 검사 정의 정책이 프록시로 작동하도록 설정되어 있지 않습니다. {#agnt_clnt_cll-POST-up-check-def-cd__ul_wbf_qps_5qb} 데이터 유형: 부울 |
| 쿼리 | 속성에 지정된 테이블에서 GlideRecord를 검색하기 위한 인코딩된 쿼리입니다 table . 데이터 유형: 문자열 |
| 테이블 | 이 검사에 대한 cmdb_ci 테이블의 이름입니다. 데이터 유형: 문자열 |
| 시간 제한 | 시간 제한(초). 데이터 유형: 숫자 |
[표 148. 요청 본문 매개변수(JSON)]

주:  
검사 정의 필드 및 유형의 전체 목록은 데이터 사전을 참조하십시오.

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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"

## 에이전트 클라이언트 수집기 - POST /agents/update/check_param/{param_id} {#ariaid-title27}

선택한 정책 검사 매개변수를 업데이트합니다.
정책 샌드박스 복사본의 속성을 검색하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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 | 정책 검사 매개변수 샌드박스 복사의 Sys_id입니다. 데이터 유형: 문자열 테이블: 검사 매개변수 \[sn_agent_check_param\] |
[표 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}

| 이름 | 설명 |
|-|-|
| 활성 | 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 매개변수가 활성 상태입니다. * false: 검사 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-POST-update-check_param__ul_u2x_5fv_2pb} 데이터 유형: 부울 |
| 플래그 |   |
| 필수 | 이 검사가 필수인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 이 검사는 필수입니다. * false: 이 검사는 선택 사항입니다. {#agnt_clnt_cll-POST-update-check_param__ul_flq_qkv_2pb} 데이터 유형: 부울 |
| 이름 | 매개변수의 이름입니다. 데이터 유형: 문자열 |
| 값 | 매개변수의 값입니다. 데이터 유형: 문자열 |
| value_required | 값 속성에서 제공하는 정보가 필수인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<param_sys_id>" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"flag\" : \"-d\",
       \"mandatory\" : \"true\",
       \"name\" : \"scheme2\",
       \"value\" : \"120\",
       \"value_required\" : \"false\"
    }" \
    --user 'username':'password'

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - POST /agents/update/check_secure_param/{param_id} {#ariaid-title28}

선택한 정책 검사 보안 매개변수를 업데이트합니다.
정책 샌드박스 복사본의 속성을 검색하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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 | 정책 검사 보안 매개변수 샌드박스 사본의 Sys_id입니다. 데이터 유형: 문자열 테이블: 보안 매개변수 검사 \[sn_agent_check_secure_param\] |
[표 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}

| 이름 | 설명 |
|-|-|
| 활성 | 보안 검사 매개변수가 활성 상태인지 여부를 나타내는 플래그입니다. 유효한 값은 다음과 같습니다. * true: 검사 보안 매개변수가 활성 상태입니다. * false: 검사 보안 매개변수가 비활성 상태입니다. {#agnt_clnt_cll-POST-update-check_secure__ul_xwy_vfv_2pb} 데이터 유형: 부울 |
| 이름 | 보안 매개변수의 이름입니다. 데이터 유형: 문자열 |
| 순서 | 매개변수가 검사 명령/스크립트로 전송되는 순서입니다. 데이터 유형: 숫자 |
[표 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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

{#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/<param_sys_id>" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
       \"name\" : \"new name\",
       \"order\" : \"2\"
    }" \
    --user 'username':'password'

출력:

    {
      "message": "Operation was successful"
    }

## 에이전트 클라이언트 수집기 - POST /agents/update/policy/{policy_id} {#ariaid-title29}

정책의 샌드박스 사본을 업데이트합니다.
정책 샌드박스 복사본의 속성을 검색하려면 [GET /agents/policy/sandbox_from_published/{policy_id}](https://servicenow-prod.fluidtopics.net/8UJsn3sn8UCZe2J7uoKjsQ#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 | 정책 샌드박스 복사본의 Sys_id입니다. 데이터 유형: 문자열 테이블: 정책 \[sn_agent_policy\] |
[표 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_id입니다. 데이터 유형: 문자열 테이블: 연결 및 자격 증명 별칭 \[sys_alias\] |
| 필터 | 지정된 기준만 모니터링하도록 정책 검사를 제한하는 필터입니다. 데이터 유형: 문자열 |
| 간격 | 정책 검사 사이에 대기하는 시간(초)입니다. 예를 들어 값이 60이면 검사가 60초마다 실행됩니다. 주: 속성 값은 checks.interval 이 필드에 구성된 값을 재정의합니다. 데이터 유형: 숫자 |
| monitored_ci_group | 정책과 연결된 [CMDB 그룹](https://www.servicenow.com/docs/access?context=cmdb-groups&version=australia&pubname=australia-servicenow-platform&ft:locale=en-US) 의 이름입니다. 이 필드는 속성 값이 monitored_ci_type_group 예인 경우에만 적용됩니다. 데이터 유형: 문자열 테이블: CMDB 그룹 \[cmdb_group\] |
| monitored_ci_script | CI를 모니터링하기 위한 스크립트입니다. 이 필드는 속성 값이 policies.monitored_ci_type_script 예인 경우에만 적용됩니다. 데이터 유형: 문자열 |
| 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} 데이터 유형: 부울 |
| 이름 | 정책 이름 데이터 유형: 문자열 |
| 테이블 | 정책의 모니터링되는 CI 유형 필드입니다. 이 필드는 true인 경우에만 monitored_ci_type_filter 적용됩니다. 데이터 유형: 문자열 |
[표 166. 요청 본문 매개변수(JSON)]

### 헤더

다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 고유한 방식으로 이 작업에 적용됩니다. REST API에 사용되는 일반 헤더 목록은 [지원되는 REST API 헤더를 참조하십시오.](https://servicenow-prod.fluidtopics.net/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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/1RuriJ1h~LGis5QmeVrYXQ "REST(REpresentational State Transfer)는 웹의 컴퓨터 시스템 간에 표준을 제공하여 서로 더 쉽게 통신할 수 있도록 하는 간단한 상태 비저장 아키텍처입니다.")
{#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}

| 이름 | 설명 |
|-|-|
| 메시지 | 작업 성공 또는 실패 결과를 포함하는 메시지입니다. 데이터 유형: 문자열 |
[ ]

### cURL 요청

다음 예는 정책의 이름과 필터 속성/필드를 업데이트하는 방법을 보여줍니다.

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

출력:

    {
      "message": "Operation was successful"
    }