@autional/api-status
v0.4.1
Published
Autional Status API — auto-generated TypeScript client from status-service
Readme
@autional/api-status
Autional Status API — auto-generated TypeScript client from status-service (26 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getStatusAdminIncidents(client, params?) | GET | /status/admin/incidents | 查询事件列表(管理面,含 demo 夹具) |
| getStatusAdminMaintenances(client, params?) | GET | /status/admin/maintenances | 查询计划维护列表(管理面,含 demo 夹具) |
| getStatusBadgeByBadge(client, service: string) | GET | /status/badge/{service} | SVG服务状态徽章 |
| getStatusIncidents(client, params?) | GET | /status/incidents | 查询事件列表 |
| postStatusIncidents(client, data: CreateIncidentRequest) | POST | /status/incidents | 创建事件 |
| deleteStatusIncidentsByIncidents(client, incidentId: string) | DELETE | /status/incidents/{incident_id} | 删除事件 |
| getStatusIncidentsByIncidents(client, incidentId: string) | GET | /status/incidents/{incident_id} | 查询事件详情 |
| putStatusIncidentsByIncidents(client, incidentId: string, data: UpdateIncidentRequest) | PUT | /status/incidents/{incident_id} | 更新事件 |
| postStatusIncidentsUpdatesByIncidents(client, incidentId: string, data: AddIncidentUpdateRequest) | POST | /status/incidents/{incident_id}/updates | 添加事件进展更新 |
| getStatusJson(client) | GET | /status/json | 机器可读系统状态 |
| getStatusMaintenances(client, params?) | GET | /status/maintenances | 查询计划维护列表 |
| postStatusMaintenances(client, data: CreateMaintenanceRequest) | POST | /status/maintenances | 创建维护预告 |
| deleteStatusMaintenancesByMaintenances(client, maintenanceId: string) | DELETE | /status/maintenances/{maintenance_id} | 删除维护预告 |
| getStatusMaintenancesByMaintenances(client, maintenanceId: string) | GET | /status/maintenances/{maintenance_id} | 查询维护详情 |
| putStatusMaintenancesByMaintenances(client, maintenanceId: string, data: UpdateMaintenanceRequest) | PUT | /status/maintenances/{maintenance_id} | 更新维护预告 |
| getStatusMetricsLatency(client, params?) | GET | /status/metrics/latency | 查询服务延迟趋势 |
| getStatusMetricsUptime(client, params?) | GET | /status/metrics/uptime | 查询服务可用率趋势 |
| getStatusOverview(client) | GET | /status/overview | 系统状态概览 |
| getStatusRss(client) | GET | /status/rss | RSS事件与维护订阅源 |
| getStatusServices(client) | GET | /status/services | 获取服务目录 |
| deleteStatusSubscriptions(client, data: UnsubscribeRequest) | DELETE | /status/subscriptions | 取消订阅 |
| getStatusSubscriptions(client, params?) | GET | /status/subscriptions | 查询订阅者列表 |
| postStatusSubscriptions(client, data: SubscribeRequest) | POST | /status/subscriptions | 订阅状态通知 |
| getStatusSubscriptionsPreferences(client, params?) | GET | /status/subscriptions/preferences | 查询订阅通知偏好 |
| putStatusSubscriptionsPreferences(client, data: SubscriptionPreferencesRequest) | PUT | /status/subscriptions/preferences | 更新订阅通知偏好 |
| postStatusSubscriptionsVerify(client, params?) | POST | /status/subscriptions/verify | 验证订阅邮箱 |
Install
npm install @autional/core @autional/api-statusQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getStatusRss } from '@autional/api-status';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getStatusRss(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
