用途
本技能面向使用 Telnyx Networking 的 JavaScript 开发者,提供通过官方 telnyx npm 包配置私有网络、WireGuard VPN 网关、互联网网关以及虚拟交叉连接的 SDK 示例。所有示例均基于已初始化的客户端对象。
安装与初始化
安装命令:
npm install telnyx
初始化方式:
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
错误处理
文档指出所有 API 调用都可能因网络错误、限流(429)、校验错误(422)或认证错误(401)而失败,建议在生产代码中始终处理错误。示例展示了针对 Telnyx.APIConnectionError、Telnyx.RateLimitError(可读取 retry-after 头并配合指数退避重试)以及 Telnyx.APIError(含 422 校验提示)的处理方式。常见错误码包括:401 无效 API 密钥、403 权限不足、404 资源未找到、422 校验错误、429 限流。
分页
列表方法返回自动分页迭代器,可使用 for await (const item of result) { ... } 自动遍历所有页面。
主要能力
网络(Networks)
- 列出所有网络:
GET /networks - 创建网络:
POST /networks,必填name - 检索网络:
GET /networks/{id} - 更新网络:
PATCH /networks/{id},必填name - 删除网络:
DELETE /networks/{id}
默认网关(Default Gateway)
- 获取默认网关状态:
GET /networks/{id}/default_gateway - 创建默认网关:
POST /networks/{id}/default_gateway - 删除默认网关:
DELETE /networks/{id}/default_gateway
Global IP
- 列出所有 Global IP:
GET /global_ips - 创建 Global IP:
POST /global_ips - 检索 Global IP:
GET /global_ips/{id} - 删除 Global IP:
DELETE /global_ips/{id}
Global IP 分配(Assignments)
- 列出所有分配:
GET /global_ip_assignments - 创建分配:
POST /global_ip_assignments - 检索分配:
GET /global_ip_assignments/{id} - 更新分配:
PATCH /global_ip_assignments/{id} - 删除分配:
DELETE /global_ip_assignments/{id}
Global IP 健康检查
- 列出所有健康检查类型:
GET /global_ip_health_check_types - 列出所有健康检查:
GET /global_ip_health_checks - 创建健康检查:
POST /global_ip_health_checks - 检索健康检查:
GET /global_ip_health_checks/{id} - 删除健康检查:
DELETE /global_ip_health_checks/{id}
指标与端口
- Global IP 分配健康检查指标:
GET /global_ip_assignment_health - Global IP 分配用量指标:
GET /global_ip_assignments_usage - Global IP 延迟指标:
GET /global_ip_latency - Global IP 用量指标:
GET /global_ip_usage - 列出所有 Global IP 允许端口:
GET /global_ip_allowed_ports - 列出所有 Global IP 协议:
GET /global_ip_protocols
AI 聚类与集成
- 列出所有聚类:
GET /ai/clusters - 计算新聚类:
POST /ai/clusters,必填bucket,可选files、min_cluster_size、min_subcluster_size、prefix - 获取聚类:
GET /ai/clusters/{task_id} - 删除聚类:
DELETE /ai/clusters/{task_id} - 获取聚类可视化:
GET /ai/clusters/{task_id}/graph - 列出集成:
GET /ai/integrations - 列出用户集成连接:
GET /ai/integrations/connections - 按 ID 获取用户集成连接:
GET /ai/integrations/connections/{user_connection_id} - 删除集成连接:
DELETE /ai/integrations/connections/{user_connection_id} - 按 ID 获取集成:
GET /ai/integrations/{integration_id}
适用场景
适用于需要在 JavaScript/Node.js 应用中通过 Telnyx SDK 管理网络资源、Global IP 及其分配、健康检查与用量指标,或调用 AI 聚类与集成接口的开发者。
限制
资料未提供收费、价格、平台支持范围、性能效果或具体使用步骤的额外说明;上述接口的必填与可选字段以文档列出的为准,未列出的字段暂未提供。