Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Web API Documentation

Jump to bottom
agile6v edited this page Apr 14, 2019 · 8 revisions

Introduction

API

/api/create

URL: http://apiserver/api/create
Method: POST
Description:

Request

{
    "Protocol": "HTTP",
    "Data": {
        "URL":              "http://127.0.0.1:8080",
        "Requests":         0,
        "Method":           "GET",
        "Concurrency":      5,
        "Timeout":          30,
        "Duration":         10,
        "ContentType":      "text/plain",
        "MaxResults":       1000000,
        "DisableKeepAlive": true
    }
}

Response

Success

{
    "data":null,
    "error":""
}

Failure


{
    "data":null,
    "error":"error message"
}

Back to TOC

/api/delete

URL: http://apiserver/api/delete
Method: POST
Description:

Request

{"ID": 10}

Response

Success

{
    "data":null,
    "error":""
}

Failure


{
    "data":null,
    "error":"error message"
}

Back to TOC

/api/search

URL: http://apiserver/api/search
Method: POST
Description:

Request

{"ID": 10}

Response

Success

{
    "data": {
        "Id": 1,
        "Status": 2,
        "Result": 0,
        "Request": "{    "protocol": "HTTP",    "data": {        "url":              "http://127.0.0.1:8080",        "requests":         0,        "method":           "GET",        "concurrency":      5,        "timeout":          30,        "duration":         30,        "contentType":      "text/plain",        "maxResults":       1000000,        "disableKeepAlive": true    }}",
        "Response": "{"data":{"id":1,"agent_stats":[{"addr":"127.0.0.1:9995","status":0,"error":""}],"result":{"totalRequests":16239,"duration":29.95055516,"fastestReqTime":0.000320163,"slowestReqTime":0.247689184,"avgReqTime":0.0016758792336557958,"avgSize":5,"totalSize":81145,"rps":542.1936225638897,"dns":{},"delay":{"max":0.245180806,"avg":0.0007949657400948895},"resp":{"max":0.003862384,"avg":0.00007648629712243511},"conn":{"max":0.247077556,"avg":0.0007320364350853411},"req":{"max":0.008363988,"avg":0.00004582410056072443},"statusCodes":{"200":16229},"errMap":{"Get http://127.0.0.1:8080: context deadline exceeded":4,"Get http://127.0.0.1:8080: dial tcp 127.0.0.1:8080: i/o timeout":6},"connDuration":11.880219305,"reqDuration":0.7436793279999967,"respDuration":1.2412961159999993,"delayDuration":12.901498995999962,"requests":16229,"totalDuration":27.19784408299991,"latencyDistribution":[{"percentage":10,"latency":0.000616996},{"percentage":25,"latency":0.000878064},{"percentage":50,"latency":0.001220902},{"percentage":75,"latency":0.0016451},{"percentage":90,"latency":0.002425912},{"percentage":95,"latency":0.003230767},{"percentage":99,"latency":0.007730589}]}},"error":""}",
        "CreatedAt": "2019-04-10T17:48:31.53927+08:00",
        "UpdatedAt": "2019-04-14T21:49:55.348827+08:00"
    },
    "error": ""
}

Failure


{
    "data":null,
    "error":"error message"
}

Back to TOC

/api/list

URL: http://apiserver/api/list
Method: GET
Description:

Request

N/A

Response

{
    "data":[
        {
            "Id":1,
            "Status":0,
            "Result":0,
            "Request":"{ "Protocol": "HTTP", "Data": { "URL": "http://127.0.0.1:8080", "Requests": 0, "Method": "GET", "Concurrency": 5, "Timeout": 30, "Duration": 10, "ContentType": "text/plain", "MaxResults": 1000000, "DisableKeepAlive": true }}",
            "Response":"",
            "CreatedAt":"2019-03-01T17:32:40+08:00",
            "UpdatedAt":"2019-03-01T17:32:40+08:00"
        },
        {
            "Id":2,
            "Status":0,
            "Result":0,
            "Request":"{ "Protocol": "HTTP", "Data": { "URL": "http://127.0.0.1:8080", "Requests": 0, "Method": "GET", "Concurrency": 5, "Timeout": 30, "Duration": 10, "ContentType": "text/plain", "MaxResults": 1000000, "DisableKeepAlive": true }}",
            "Response":"",
            "CreatedAt":"2019-03-01T18:10:40+08:00",
            "UpdatedAt":"2019-03-01T18:10:40+08:00"
        }
    ],
    "error":""
}

Back to TOC

/api/start

URL: http://apiserver/api/start
Method: POST
Description:

Request

{"ID": 10}

Response

Success

{
    "data":null,
    "error":""
}

Failure


{
    "data":null,
    "error":"error message"
}

Back to TOC

/api/stop

URL: http://apiserver/api/stop
Method: POST
Description:

Request

{"ID": 10}

Response

Success

{
    "data":null,
    "error":""
}

Failure


{
    "data":null,
    "error":"error message"
}

Back to TOC

Clone this wiki locally