PHP WHMCS GetServers用法及代碼示例

獲取服務器。

請求參數

參數	類型	說明	必需的
action	string	“GetServers”	Required
serviceId	int	傳遞產品/服務 ID 以獲取其模塊類型的可用服務器。	Optional
addonId	int	傳遞一個插件/服務 ID 以獲取其模塊類型的可用服務器。	Optional
fetchStatus	bool	作為 true 傳遞以嘗試獲取服務器狀態值。	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'GetServers',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'serviceId' => '1',
            'fetchStatus' => false,
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'GetServers';
$postData = array(
    'serviceId' => '1',
    'fetchStatus' => false,
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success",
    "servers": [
        {
            "id": 1,
            "name": "Sample cPanel Box",
            "hostname": "hostname.example.com",
            "ipaddress": "10.100.4.30",
            "active": true,
            "activeServices": 0,
            "maxAllowedServices": 200,
            "percentUsed": 0,
            "module": "cpanel",
            "status": {
                "http": false,
                "load": "",
                "uptime": ""
            }
        }
    ],
    "fetchStatus": ""
}