
本教程详细阐述如何通过guzzle客户端从atera restful api获取所有分页数据。针对api的内置分页机制,文章指导读者采用迭代循环策略,通过动态调整请求中的页码参数,逐步抓取所有页面数据,并将其聚合,从而克服单次请求的限制,实现全量数据的高效采集与存储。
多数RESTful API为了优化性能、管理服务器负载及提升响应速度,会采用分页(Pagination)机制限制单次请求返回的数据量。这意味着即使数据总量庞大,API也不会一次性返回所有记录,而是将数据拆分成多个“页”,每次请求只返回一页的数据。用户需要通过一系列请求来获取所有页面。
以Atera API为例,其响应结构清晰地展示了分页信息:
{
"items": [
{
"AlertID": xxxx,
"Code": xxxx,
"Source": "string",
"Title": "string",
"Severity": "Information",
"Created": "2021-12-01T01:09:52.888Z",
"SnoozedEndDate": "2021-12-01T01:09:52.888Z",
"DeviceGuid": "string",
"AdditionalInfo": "string",
"Archived": true,
"AlertCategoryID": "Hardware",
"ArchivedDate": "2021-12-01T01:09:52.888Z",
"TicketID": xxxx,
"AlertMessage": "string",
"DeviceName": "string",
"CustomerID": xxxx,
"CustomerName": "string",
"FolderID": xxxx,
"PollingCyclesCount": 0
}
],
"totalItemCount": 6783,
"page": 1,
"itemsInPage": 20,
"totalPages": 290,
"prevLink": "",
"nextLink": "http://app.atera.com/api/v3/alerts?page=2&itemsInPage=20"
}
从上述响应中,我们可以识别出几个关键字段:
这些信息明确指出,Atera API默认每页返回20个项目,并且提供了总页数和下一页的链接。因此,尝试通过items=6000、limit=6000等参数直接获取所有数据是无效的,因为API设计者并未提供此类接口,而是要求通过分页机制逐页获取。
要从分页API中获取所有数据,核心策略是循环请求每一页,直到所有页面都被访问。这通常涉及以下步骤:
以下PHP代码示例展示了如何使用Guzzle HTTP客户端实现Atera API的全量数据抓取。此示例基于页码迭代方式。
<?php
<p>require 'vendor/autoload.php'; // 确保Guzzle已通过Composer安装</p><p>use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;</p><p>/**</p>
<div class="aritcle_card">
<a class="aritcle_card_img" href="/ai/%E5%9B%BE%E5%8F%AF%E4%B8%BD%E6%89%B9%E9%87%8F%E6%8A%A0%E5%9B%BE">
<img src="https://img.php.cn/upload/ai_manual/001/431/639/68b6c8f120a83696.png" alt="图可丽批量抠图">
</a>
<div class="aritcle_card_info">
<a href="/ai/%E5%9B%BE%E5%8F%AF%E4%B8%BD%E6%89%B9%E9%87%8F%E6%8A%A0%E5%9B%BE">图可丽批量抠图</a>
<p>用AI技术提高数据生产力,让美好事物更容易被发现</p>
<div class="">
<img src="/static/images/card_xiazai.png" alt="图可丽批量抠图">
<span>26</span>
</div>
</div>
<a href="/ai/%E5%9B%BE%E5%8F%AF%E4%B8%BD%E6%89%B9%E9%87%8F%E6%8A%A0%E5%9B%BE" class="aritcle_card_btn">
<span>查看详情</span>
<img src="/static/images/cardxiayige-3.png" alt="图可丽批量抠图">
</a>
</div>
<ul><li><p>从Atera API获取所有告警数据。</p></li><li></li><li><p>@param string $apiKey 您的Atera API密钥。</p></li><li><p>@param int $itemsInPage 每页请求的项目数(API允许的最大值,Atera通常固定为20)。</p></li><li><p>@return array 包含所有告警数据的数组。</p></li><li><p>@throws Exception 如果API请求失败或数据解析异常。
*/
function fetchAllAteraAlerts(string $apiKey, int $itemsInPage = 20): array
{
$client = new Client();
$baseUrl = '<a href="https://www.php.cn/link/f08bc848e028e7f9d65567f2ddc15951" rel="nofollow" target="_blank" >https://www.php.cn/link/f08bc848e028e7f9d65567f2ddc15951</a>';
$allAlerts = [];
$currentPage = 1;
$totalPages = 1; // 初始设置为1,确保至少执行一次请求以获取实际总页数</p><p>echo "开始从Atera API获取所有告警数据...\n";</p><p>do {
try {
echo "正在获取第 {$currentPage} 页 (每页 {$itemsInPage} 条)...\n";
$response = $client->get($baseUrl, [
'headers' => [
'X-Api-Key' => $apiKey,
'Accept' => 'application/json' // 明确指定接受JSON响应
],
'query' => [
'page' => $currentPage,
'itemsInPage' => $itemsInPage
],
'timeout' => 30 // 设置请求超时时间(秒)
]);</p><pre class="brush:php;toolbar:false;"> $data = json_decode($response->getBody()->getContents(), true);
if (json_last_error() !== JSON_ERROR_NONE) {
throw new Exception("JSON解析错误: " . json_last_error_msg());
}
if (!isset($data['items']) || !is_array($data['items'])) {
throw new Exception("API响应中缺少 'items' 数组或其格式不正确。");
}
$allAlerts = array_merge($allAlerts, $data['items']);
$totalPages = $data['totalPages'] ?? $totalPages; // 更新总页数,如果API响应中未提供则保留原值
$currentPage++;
echo "已获取 {$data['itemsInPage']} 条数据,当前总计 {$data['totalItemCount']} 条中的 " . count($allAlerts) . " 条。\n";
// 可选:添加延迟以避免触犯API速率限制
// sleep(1); // 每页请求后暂停1秒,根据API限制和需求调整
} catch (GuzzleException $e) {
// 捕获Guzzle特有的HTTP请求异常
throw new Exception("Guzzle HTTP请求失败: " . $e->getMessage() . " (Code: " . $e->getCode() . ")");
} catch (Exception $e) {
// 捕获其他自定义异常(如JSON解析错误)
throw $e;
}} while ($currentPage zuojiankuohaophpcn= $totalPages); // 当当前页码小于或等于总页数时继续循环
echo "所有告警数据获取完毕。总计 " . count($allAlerts) . " 条。\n"; return $allAlerts; }
// --- 使用示例 --- $yourApiKey = 'YOUR_ATERA_API_KEY'; // 替换为您的实际API密钥
try { $allAteraAlerts = fetchAllAteraAlerts($yourApiKey); // 现在 $allAteraAlerts 包含了所有页面的数据 // 您可以将其存储到数据库,例如MongoDB echo "成功获取 " . count($allAteraAlerts) . " 条告警记录。\n"; // 示例:打印第一条记录 // if (!empty($allAteraAlerts)) { // print_r($allAteraAlerts[0]); // } } catch (Exception $e) { echo "发生错误: " . $e->getMessage() . "\n"; }
?>
通过理解并正确实现
以上就是从Atera RESTful API高效获取全量数据的分页处理教程的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号