---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AccCheckDefsAPI :スコープ指定

# AccCheckDefsAPI :スコープ指定 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：22分

AccCheckDefsAPI スクリプトインクルードを使用すると、チェック定義と関連パラメーターを管理できます。

このスクリプトインクルードには エージェントクライアントコレクター Framework (sn_agent) ストアアプリケーションが必要であり、 `sn_agent` 名前空間内で提供されます。このスクリプトインクルードには agent_client_collector_admin ロールが必要です。詳細については、「 [エージェントクライアントコレクター](https://www.servicenow.com/docs/access?context=acc-landing-page&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」を参照してください。

このスクリプトインクルードには、インスタンスを作成するためのコンストラクタはありません。AccCheckDefsAPI 静的クラスを次の形式で使用して、各メソッドを呼び出します。

`sn_agent.AccCheckDefsAPI.<method>`

REST API ソリューションについては、「 [エージェントクライアントコレクター API](https://servicenow-prod.fluidtopics.net/Id71AT_lAinkjm~KVoTIag#agnt_clnt_cll-api "Agent Client Collector API は、利用可能なエージェントのアクションと管理ポリシーを管理するためのエンドポイントを提供します。")」を参照してください。  
このスクリプトインクルードは、以下を有効にするメソッドを提供します。

* 指定されたチェック定義を取得
* チェック定義のリストを取得
* チェックとチェックパラメーターを更新
{#AccCheckDefsAPIAPIScoped__ul_rqf_bdx_5qb}

## AccCheckDefsAPI - getCheck(文字列 checkDefId, ブール withParams) {#ariaid-title2}

詳細を含む指定されたチェック定義を取得します。
{#AccCkDf-getCheck_S_B__table_zk2_2g2_z4b__entry__3}{#AccCkDf-getCheck_S_B__accCheckDefs-parms-withParms-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| checkDefId | 文字列 | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 |
| withParams | ブール | 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。 有効な値： * true：チェックパラメーターの詳細を返します。 * false：チェックパラメーターの詳細を返しません。 {#AccCkDf-getCheck_S_B__ul_pv3_gqc_wqb} デフォルト値：False |
[表 : 1. パラメーター]

{#AccCkDf-getCheck_S_B__table_zk2_2g2_z4b} {#AccCkDf-getCheck_S_B__table_al2_2g2_z4b__entry__2}{#AccCkDf-getCheck_S_B__accCkDf-background-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-chkGrp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-chkTyp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-command-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-active-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-default-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-mando-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-p-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-plugins-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-proxy-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-active-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-name-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-order-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-sp-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-id-desc-ph}{#AccCkDf-getCheck_S_B__accCkDf-timeout-desc-ph}

| プロパティ | 説明 |
|-|-|
| check | 指定されたチェック定義の詳細。 "check ": { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "error": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } |
| check.background | このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待たないチェックです。 有効な値： * true：このチェック定義はバックグラウンドチェックです。 * false：このチェック定義はバックグラウンドチェックではありません。 {#AccCkDf-getCheck_S_B__ul_ypb_5ps_5qb} データタイプ：ブール |
| check.check_group | このチェック定義に指定されたグループ。 データタイプ：文字列 |
| check.check_type | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#AccCkDf-getCheck_S_B__ul_gtr_kfb_wqb} データタイプ：文字列 |
| check.command | エージェントクライアントコレクター が実行するコマンド。 データタイプ：文字列 |
| check.error | エラーがある場合のメッセージ。それ以外の場合は Null です。 データタイプ：文字列 |
| check.name | チェックの名前。 データタイプ：文字列 |
| check.params | チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#AccCkDf-getCheck_S_B__accCkDf-p-code} データタイプ：アレイ |
| check.params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#AccCkDf-getCheck_S_B__ul_pnb_jyc_wqb} データタイプ：ブール |
| check.params.default_value | このチェックパラメーターのデフォルト値を指定します。 データタイプ：文字列 |
| check.params.mandatory | チェックパラメーターが必須かどうかを示すフラグ。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#AccCkDf-getCheck_S_B__ul_wtg_2zc_wqb} データタイプ：ブール |
| check.params.name | チェックパラメーターの名前。 データタイプ：文字列 |
| check.params.sys_id | チェックセキュアパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 データタイプ：文字列 |
| check.plugins | このチェックに関連付けられている [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) のリスト。 データタイプ：アレイ |
| check.proxy_valid | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#AccCkDf-getCheck_S_B__ul_wbf_qps_5qb} データタイプ：ブール |
| check.secure_params | このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#AccCkDf-getCheck_S_B__accCkDf-sp-code} データタイプ：アレイ |
| check.secure_params.active | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#AccCkDf-getCheck_S_B__ul_g1b_3vc_wqb} データタイプ：ブール |
| check.secure_params.name | セキュアパラメーターの名前。 データタイプ：文字列 |
| check.secure_params.order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：数値 |
| check.secure_params.sys_id | チェックセキュアなパラメーター定義 \[sn_agent_check_secure_param_def\] テーブルにリストされたセキュアパラメーターの sys_id。 データタイプ：文字列 |
| check.sys_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 データタイプ：文字列 |
| check.timeout | タイムアウト (秒)。 データタイプ：数値 |
[表 : 2. 返される内容]

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

    var checkDefId = "94436b237f705300f128134f8dfa91a4";
    var withParams = true;

    var checkDef = sn_agent.AccCheckDefsAPI.getCheck(checkDefId, withParams);

    gs.info(JSON.stringify(checkDef, null, 2));

出力:

    {
      "check": {
        "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"
          }
        ]
      },
      "error": null
    }

## AccCheckDefsAPI - getChecksList(文字列 encodedQuery, 数値 limit, ブール withParams) {#ariaid-title3}

詳細を含むチェック定義のリストを取得します。
「 [チェックとポリシー](https://www.servicenow.com/docs/access?context=checks-policies&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」も参照してください。
{#AccCkDf-getChecksList_S_N_B__table_zk2_2g2_z4b__entry__3}{#AccCkDf-getChecksList_S_N_B__accCheckDefs-parms-encQuery-desc}{#AccCkDf-getChecksList_S_N_B__accCheckDefs-parms-withParms-desc}

| 名前 | タイプ | 説明 |
|-|-|-|
| encodedQuery | 文字列 | チェック定義の結果リストをフィルタリングするための [エンコードされたクエリ文字列](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) 。システム内のチェック定義のフィルタリングされていないリストには null を使用します。 |
| limit | 番号 | 返されるレコードの数を制限します。デフォルト値を使用するには、null に設定します。 デフォルト：20,000 |
| withParams | ブール | 既存のチェックパラメーターの詳細が返されるかどうかを示すフラグ。標準およびセキュアな各チェックパラメーターの情報は、JSON オブジェクトに含まれています。 有効な値： * true：チェックパラメーターの詳細を返します。 * false：チェックパラメーターの詳細を返しません。 {#AccCkDf-getChecksList_S_N_B__ul_pv3_gqc_wqb} デフォルト値：False |
[表 : 3. パラメーター]

{#AccCkDf-getChecksList_S_N_B__table_zk2_2g2_z4b} {#AccCkDf-getChecksList_S_N_B__table_al2_2g2_z4b__entry__2}{#AccCkDf-getChecksList_S_N_B__accCkDf-background-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-chkGrp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-chkTyp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-command-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-active-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-default-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-mando-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-p-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-plugins-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-proxy-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-active-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-name-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-order-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-sp-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-id-desc-ph}{#AccCkDf-getChecksList_S_N_B__accCkDf-timeout-desc-ph}

| プロパティ | 説明 |
|-|-|
| チェック定義 | JSON オブジェクトとして指定されたチェック定義と詳細のリスト。 [ { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "params": [Array], "plugins": [Array], "proxy_valid": Boolean, "secure_params": [Array], "sys_id": "String", "timeout": Number } ] データタイプ：アレイ |
| background | このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待たないチェックです。 有効な値： * true：このチェック定義はバックグラウンドチェックです。 * false：このチェック定義はバックグラウンドチェックではありません。 {#AccCkDf-getChecksList_S_N_B__ul_ypb_5ps_5qb} データタイプ：ブール |
| check_group | このチェック定義に指定されたグループ。 データタイプ：文字列 |
| check_type | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#AccCkDf-getChecksList_S_N_B__ul_gtr_kfb_wqb} データタイプ：文字列 |
| command | エージェントクライアントコレクター が実行するコマンド。 データタイプ：文字列 |
| name | チェックの名前。 データタイプ：文字列 |
| params | チェック定義に関連付けられたパラメーター定義のリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "params": [ { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String", "sys_id": "String" } ] {#AccCkDf-getChecksList_S_N_B__accCkDf-p-code} データタイプ：アレイ |
| params.active | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#AccCkDf-getChecksList_S_N_B__ul_pnb_jyc_wqb} データタイプ：ブール |
| params.default_value | このチェックパラメーターのデフォルト値を指定します。 データタイプ：文字列 |
| params.mandatory | チェックパラメーターが必須かどうかを示すフラグ。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#AccCkDf-getChecksList_S_N_B__ul_wtg_2zc_wqb} データタイプ：ブール |
| params.name | チェックパラメーターの名前。 データタイプ：文字列 |
| params.sys_id | チェックセキュアパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 データタイプ：文字列 |
| プラグイン | このチェックに関連付けられている [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) のリスト。 データタイプ：アレイ |
| proxy_valid | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#AccCkDf-getChecksList_S_N_B__ul_wbf_qps_5qb} データタイプ：ブール |
| secure_params | このチェックにアサインされたリスト。これらの結果は、withParams パラメーターが true に設定されている場合にのみ含まれます。 "secure_params": [ { "active": Boolean, "name": "String", "order": Number, "sys_id": "String" } ] {#AccCkDf-getChecksList_S_N_B__accCkDf-sp-code} データタイプ：アレイ |
| secure_params.active | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#AccCkDf-getChecksList_S_N_B__ul_g1b_3vc_wqb} データタイプ：ブール |
| secure_params.name | セキュアパラメーターの名前。 データタイプ：文字列 |
| secure_params.order | パラメーターがチェックコマンド/スクリプトに送信される順序。 データタイプ：数値 |
| secure_params.sys_id | チェックセキュアなパラメーター定義 \[sn_agent_check_secure_param_def\] テーブルにリストされたセキュアパラメーターの sys_id。 データタイプ：文字列 |
| sys_id | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 データタイプ：文字列 |
| timeout | タイムアウト (秒)。 データタイプ：数値 |
[表 : 4. 返される内容]

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

    var encQuery = "nameSTARTSWITHchecks_";
    var limit = 2;
    var withParams = true;

    var checkDefs = sn_agent.AccCheckDefsAPI.getChecksList(encQuery, limit, withParams);

    gs.info(JSON.stringify(checkDefs, null, 2));

出力：

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

## AccCheckDefsAPI - updateCheck(文字列 checkDefId, オブジェクト updateJson) {#ariaid-title4}

指定されたチェック定義の 1 つ以上のフィールド値を変更できるようにします。
「 [チェックとポリシー](https://www.servicenow.com/docs/access?context=checks-policies&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US)」も参照してください。
{#AccCkDf-updateCheck_S_O__table_zk2_2g2_z4b__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| checkDefId | 文字列 | チェック定義 \[sn_agent_check_def\] テーブルにリストされたチェック定義の sys_id。 |
| updateJson | オブジェクト | 新しい値に更新されるチェック定義フィールドのマップ。チェック定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。 { "background": Boolean, "check_group": "String", "check_type": "String", "command": "String", "name": "String", "plugins": [Array], "proxy_valid": Boolean, "timeout": Number } |
| updateJson.active | 番号 | このチェック定義がアクティブかどうかを示します。 有効な値： * 0：このチェック定義は非アクティブです。 * 1：このチェック定義はアクティブです。 {#AccCkDf-updateCheck_S_O__ul_gdc_4wj_wqb} |
| updateJson.background | ブーリアン | このチェック定義がバックグラウンドチェックかどうかを示すフラグ。バックグラウンドチェックは、エージェントが実行を開始し、実行が終了するのを待たないチェックです。 有効な値： * true：このチェック定義はバックグラウンドチェックです。 * false：このチェック定義はバックグラウンドチェックではありません。 {#AccCkDf-updateCheck_S_O__ul_ypb_5ps_5qb} |
| updateJson.check_group | 文字列 | このチェック定義に指定されたグループ。 |
| updateJson.check_type | 文字列 | チェックのタイプ。 可能な値： * Events：チェック結果が Event Management イベントに変換されます。 * Metrics：チェック結果からの値が測定基準に変換されます。 {#AccCkDf-updateCheck_S_O__ul_gtr_kfb_wqb} |
| updateJson.command | 文字列 | エージェントクライアントコレクター が実行するコマンド。 |
| updateJson.name | 文字列 | チェックの名前。 |
| updateJson.plugins | アレイ | のリスト [エージェントクライアントコレクター プラグイン](https://www.servicenow.com/docs/access?context=acc-assets&version=xanadu&pubname=xanadu-it-operations-management&ft:locale=en-US) このチェックに関連付けられています。 |
| updateJson.proxy_valid | ブーリアン | チェック定義ポリシーがプロキシとして機能するように設定されているかどうかを示すフラグ。 有効な値： * true：このチェック定義ポリシーはプロキシとして機能するように設定されています。 * false：このチェック定義ポリシーはプロキシとして機能するように設定されていません。 {#AccCkDf-updateCheck_S_O__ul_wbf_qps_5qb} |
| updateJson.timeout | 番号 | タイムアウト (秒)。 |
[表 : 5. パラメーター]

{#AccCkDf-updateCheck_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheck_S_O__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし | 失敗した場合のエラーメッセージ。 |
[表 : 6. 返される内容]

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

    var checkJson = sn_agent.AccCheckDefsAPI.getCheck(activeCheckDefs[0].sys_id, true);
    if (!gs.nil(checkJson.error))
    	gs.error(checkJson.error);

    var updateJson = {active: "0"}; // deactivate the check definition
    sn_agent.AccCheckDefsAPI.updateCheck(checkJson.check.sys_id, updateJson);

## AccCheckDefsAPI - updateCheckParam(文字列 checkDefParamId, オブジェクト updateJson) {#ariaid-title5}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| checkDefParamId | 文字列 | チェックパラメーター定義 \[sn_agent_check_param_def\] テーブルにリストされたチェックパラメーターの sys_id。 |
| updateJson | オブジェクト | 新しい値に更新されるチェックパラメーターフィールドのマップ。チェックセキュアパラメーター定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。 { "active": Boolean, "default_value": "String", "mandatory": Boolean, "name": "String" } |
| updateJson.active | ブーリアン | チェックパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：チェックパラメーターはアクティブです。 * false：チェックパラメーターは非アクティブです。 {#AccCkDf-updateCheckParam_S_O__ul_pnb_jyc_wqb} |
| updateJson.default_value | 文字列 | このチェックパラメーターのデフォルト値を指定します。 |
| updateJson.mandatory | ブーリアン | チェックパラメーターが必須かどうかを示すフラグ 。 有効な値： * true：チェックパラメーターは必須です。 * false：チェックパラメーターはオプションです。 {#AccCkDf-updateCheckParam_S_O__ul_wtg_2zc_wqb} |
| updateJson.name | 文字列 | チェックパラメーターの名前。 |
[表 : 7. パラメーター]

{#AccCkDf-updateCheckParam_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheckParam_S_O__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし | 失敗した場合のエラーメッセージ。 |
[表 : 8. 返される内容]

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

    var checkParmSysId = "cd922ce6dba530106f4810284b961966";
    var updateJson = {"active": "true"};
    sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkParmSysId, updateJson);

## AccCheckDefsAPI - updateCheckSecureParam(文字列 checkDefSecureParamId, オブジェクト updateJson) {#ariaid-title6}

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

| 名前 | タイプ | 説明 |
|-|-|-|
| checkDefSecureParamId | 文字列 | チェックセキュアパラメーター定義 \[sn_agent_check_secure_param_def\] テーブルにリストされたセキュアパラメーターの sys_id。 |
| updateJson | オブジェクト | 新しい値に更新されるチェックセキュアパラメーターフィールドのマップ。チェックセキュアパラメーター定義のフィールドとタイプの包括的なリストについては、データディクショナリを参照してください。 { "active": Boolean, "name": "String", "order": Number } |
| updateJson.active | ブーリアン | セキュアパラメーターがアクティブかどうかを示すフラグ。 有効な値： * true：セキュアパラメーターはアクティブです。 * false：セキュアパラメーターは非アクティブです。 {#AccCkDf-updateCheckSecureParam_S_O__ul_g1b_3vc_wqb} |
| updateJson.name | 文字列 | セキュアパラメーターの名前。 |
| updateJson.order | 番号 | パラメーターがチェックコマンド/スクリプトに送信される順序。 |
[表 : 9. パラメーター]

{#AccCkDf-updateCheckSecureParam_S_O__table_zk2_2g2_z4b} {#AccCkDf-updateCheckSecureParam_S_O__table_al2_2g2_z4b__entry__2}

| タイプ | 説明 |
|-|-|
| なし | 失敗した場合のエラーメッセージ。 |
[表 : 10. 返される内容]

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

    var checkSecParmSysId = "<sys_id>";
    var updateJson = {"active": "true"};
    sn_agent.AccCheckDefsAPI.updateCheckSecureParam(checkSecParmSysId, updateJson);