ServiceUptime.com API 的 PHP 库 (https://www.serviceuptime.com/users/api-docs.php)

1.0.2 2020-09-18 10:29 UTC

This package is auto-updated.

Last update: 2024-09-18 19:46:18 UTC


README

ServiceUptime API 的 PHP 库 (https://www.serviceuptime.com/users/api-docs.php)

依赖

需要 PHP 版本 >= 7。

以下 PHP 扩展是必需的

  • curl

安装

将 ServiceUptime API 添加到您的 composer.json 文件。

{
  "require": {
    "serviceuptime/api": "*"
  }
}

示例

初始化 api

<?php
    $suapi = new \ServiceUptime\API\API('APIKEY');
?>

将新的监控器添加到您的 ServiceUptime 账户

<?php
    $monitor = $suapi->addMonitor([
		"Id" => "234342",
		"Name" => "domain.com",
		"CheckPeriod" => "5",
		"ServiceType" => "http",
		"Port" => "80",
		"HostName" => "domain.com",
		"HTTPAuthLogin" => "user1",
		"HTTPAuthPassword" => "pass123",
		"SendDefaultAlert" => "y",
		"SendAltAlert" => "domain.support@gmail.com;user.name@hotmail.com;tech@domain.com",
		"FailuresBeforeAlert" => "1",
		"SendDefaultSMS" => "n",
		"SendAltSMS" => "+11234567890;+10987654321",
		"FailuresBeforeSMS" => "3",
		"SendJabberAlert" => "n",
		"WebHookUrl" => "",
		"Timeout" => "15",
		"DownAlertSubject" => "Domain.com (http) is Down!",
		"UpAlertSubject" => "Domain.com (http) is Up!",
		"RepeatAlerts" => "0",
		"NoUpAlerts" => "n",
		"HighPriorityAlerts" => "y",
		"Enabled" => "y",
		"PublicStatAllowed" => "y",
		"HostPage" => "domain.com",
		"Status" => "active",
		"StatusMessage" => "Monitor is UP",
		"PubStatUrl" => "http://www.serviceuptime.com/users/uptimemonitoring.php?S=e4c9e21eb1222a4adb4a1da4cbc4a653&Id=234342",
		"LastCheckDate" => "2014-07-23 13:08:12",
		"LastCheckDateFormatted" => "34 sec. ago",
		"TotalChecks" => 909600,
		"TotalOutages" => 449,
		"TotalFailedChecks" => 921,
		"TotalUptime" => 99.899,
    ]);
    print_r($monitor);
?>

编辑监控器信息

<?php
    $monitor = $suapi->updateMonitor([
		"Id" => "234342",
		"ServiceType" => "http",
		"Port" => "80",
    ]);
    print_r($monitor);
?>

从您的 ServiceUptime 账户中删除监控器

<?php
    $result = $suapi->deleteMonitor([
        "Id" => "234342",
    ]);
    print_r($result);
?>

检索所有监控器信息,包括正常运行时间统计摘要和当前状态信息

<?php
    $monitors = $suapi->getMonitors();
    print_r($monitors);
?>

检索监控器的详细正常运行时间报告

<?php
    $report = $suapi->getReport([
        "Id" => "367168",
        "from_date" => "2019-11-01",
        "to_date" => "2019-11-07",
    ]);
    print_r($report);
?>

检索一个监控器的信息,包括正常运行时间统计摘要和当前状态信息

<?php
    $monitor = $suapi->monitorInfo([
        "Id" => "367168",
    ]);
    print_r($monitor);
?>

启动暂停监控器的监控

<?php
    $result = $suapi->startMonitor([
        "Id" => "367168",
    ]);
    print_r($result);
?>

暂停监控器的监控

<?php
    $result = $suapi->stopMonitor([
        "Id" => "367168",
    ]);
    print_r($result);
?>

检索账户信息,例如短信信用额度、可用监控器、默认电子邮件警报等。

<?php
    $account = $suapi->accountInfo();
    print_r($account);
?>

文档

许可

MIT 许可证 (MIT)