httptest.create

説明

object httptest.create(object/array webScenarios)

このメソッドでは、新しいWebシナリオを作成できます。

Webシナリオを作成すると、Webモニタリングアイテムのセットが自動的に作成されます。

このメソッドはAdminおよびSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。

パラメータ

(object/array) Webシナリオの作成

このメソッドは標準のWebシナリオプロパティに加えて、次のパラメーターを受け入れます。

パラメータ タイプ 説明
steps
(必須)		 array Webシナリオのステップ.
tags array Webシナリオのタグ

戻り値

(object) httptestidsプロパティの下で作成されたWebシナリオのIDを含むオブジェクトを返します。 返されるIDの順序は、渡されたWebシナリオの順序と一致します。

例

Webシナリオの作成

ホームページを監視するためのWebシナリオを作成します。 シナリオには、ホームページと「バージョン情報」ページをチェックしてHTTPステータスコード200が返されることを確認する2つのステップがあります。

Request:

{
    "jsonrpc": "2.0",
    "method": "httptest.create",
    "params": {
        "name": "Homepage check",
        "hostid": "10085",
        "steps": [
            {
                "name": "Homepage",
                "url": "http://example.com",
                "status_codes": "200",
                "no": 1
            },
            {
                "name": "Homepage / About",
                "url": "http://example.com/about",
                "status_codes": "200",
                "no": 2
            }
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "httptestids": [
            "5"
        ]
    },
    "id": 1
}

参照

ソース

CHttpTest::create() in ui/include/classes/api/services/CHttpTest.php.