httptest.get

Apraksts

integer/array httptest.get(object parameters)

Metode ļauj izgūt tīmekļa scenārijus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
groupids ID/array Atgriezt tikai tīmekļa scenārijus, kas pieder norādītajām hostu grupām.
hostids ID/array Atgriezt tikai tīmekļa scenārijus, kas pieder norādītajiem hostiem.
httptestids ID/array Atgriezt tikai tīmekļa scenārijus ar norādītajiem ID.
inherited boolean Ja iestatīts uz true, atgriezt tikai tīmekļa scenārijus, kas mantoti no veidnes.
inheritedTags boolean Atgriezt tīmekļa scenārijus, kuriem norādītās tags ir arī veidnē/hostā/piesaistītajās veidnēs.

Iespējamās vērtības:
true - veidnei/hostam/piesaistītajām veidnēm arī jābūt norādītajām birkām;
false - (noklusējums) birkas no veidnes/hosta/piesaistītajām veidnēm tiek ignorētas.
monitored boolean Ja iestatīts uz true, atgriezt tikai iespējotus tīmekļa scenārijus, kas pieder uzraudzītiem hostiem.
selectInheritedTags query Atgriezt inheritedTags īpašību ar birkām, kas atrodas veidnē/hostā/piesaistītajās veidnēs.
templated boolean Ja iestatīts uz true, atgriezt tikai tīmekļa scenārijus, kas pieder veidnēm.
templateids ID/array Atgriezt tikai tīmekļa scenārijus, kas pieder norādītajām veidnēm.
expandName flag Izvērst makrosus tīmekļa scenārija nosaukumā.
expandStepName flag Izvērst makrosus scenārija soļu nosaukumos.
evaltype integer Birku novērtēšanas metode.

Iespējamās vērtības:
0 - (noklusējums) Un/Vai;
2 - Vai.
tags array Atgriezt tikai tīmekļa scenārijus ar norādītajām birkām.
Formāts: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Tukšs masīvs atgriež visus tīmekļa scenārijus.

Iespējamās operator vērtības:
0 - (noklusējums) Satur;
1 - Vienāds ar;
2 - Nesatur;
3 - Nav vienāds ar;
4 - Eksistē;
5 - Neeksistē.
selectHosts query Atgriezt hostus, kuriem pieder tīmekļa scenārijs, kā masīvu hosts īpašībā.
selectSteps query Atgriezt tīmekļa scenārija soļus steps īpašībā.

Atbalsta count.
selectTags query Atgriezt tīmekļa scenārija birkas tags īpašībā.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: httptestid, name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Tīmekļa scenārija izgūšana

Izgūstiet visus datus par tīmekļa scenāriju "9".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "httptest.get",
    "params": {
        "output": "extend",
        "selectSteps": "extend",
        "httptestids": "9"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "httptestid": "9",
            "name": "Homepage check",
            "delay": "1m",
            "status": "0",
            "agent": "Zabbix",
            "authentication": "0",
            "http_user": "",
            "http_password": "",
            "hostid": "10084",
            "templateid": "0",
            "http_proxy": "",
            "retries": "1",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "uuid": "",
            "headers": [],
            "variables": [],
            "steps": [
                {
                    "httpstepid": "36",
                    "httptestid": "9",
                    "name": "Homepage",
                    "no": "1",
                    "url": "http://example.com",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [
                        {
                            "name":"{var}",
                            "value":"12"
                        }
                    ],
                    "query_fields": []
                },
                {
                    "httpstepid": "37",
                    "httptestid": "9",
                    "name": "Homepage / About",
                    "no": "2",
                    "url": "http://example.com/about",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "post_type": "1",
                    "headers": [],
                    "variables": [],
                    "query_fields": []
                }
            ]
        }
    ],
    "id": 1
}

Skatiet arī

Avots

CHttpTest::get() failā ui/include/classes/api/services/CHttpTest.php.