Telnyx Networking - curl 是一份面向 Telnyx 网络能力的 REST API 使用参考,全部示例以 curl 命令呈现,用于配置私有网络、WireGuard VPN 网关、互联网网关和虚拟交叉连接等网络资源。
用途 该技能用于通过 Telnyx REST API 以命令行方式管理网络相关资源,包括网络(Networks)、默认网关(Default Gateway)、Global IP 及其分配、健康检查、协议、允许端口,以及用量与延迟等指标。
安装与认证 curl 在 macOS、Linux 和 Windows 10+ 上已预装,无需额外安装。使用前需设置环境变量:export TELNYX_API_KEY="YOUR_API_KEY_HERE"。所有示例均使用 $TELNYX_API_KEY 进行认证,请求头为 Authorization: Bearer $TELNYX_API_KEY。
主要能力
- 网络管理:列出、创建、检索、更新、删除网络(GET/POST /networks,GET/PATCH/DELETE /networks/{id}),创建网络时 name 为必填。
- 默认网关:获取默认网关状态、创建默认网关、删除默认网关(GET/POST/DELETE /networks/{id}/default_gateway),返回字段包含 network_id、status、wireguard_peer_id 等。
- Global IP:列出、创建、检索、删除 Global IP(GET/POST /global_ips,GET/DELETE /global_ips/{id}),返回字段包含 ip_address、name、ports 等。
- Global IP 分配:列出、创建、检索、更新、删除分配(GET/POST /global_ip_assignments,GET/PATCH/DELETE /global_ip_assignments/{id}),返回字段包含 global_ip_id、is_announced、is_connected、is_in_maintenance、status、wireguard_peer_id 等。
- Global IP 健康检查:列出健康检查类型、列出/创建/检索/删除健康检查(GET /global_ip_health_check_types,GET/POST /global_ip_health_checks,GET/DELETE /global_ip_health_checks/{id})。
- 指标与辅助数据:Global IP 分配健康检查指标(GET /global_ip_assignment_health)、分配用量指标(GET /global_ip_assignments_usage)、延迟指标(GET /global_ip_latency)、用量指标(GET /global_ip_usage)、允许端口(GET /global_ip_allowed_ports)、协议(GET /global_ip_protocols)。
- AI 相关接口:列出集群、计算新集群、获取/删除集群、获取集群可视化(GET/POST /ai/clusters,GET/DELETE /ai/clusters/{task_id},GET /ai/clusters/{task_id}/graph),以及集成列表与用户集成连接管理(GET /ai/integrations,GET /ai/integrations/connections,GET/DELETE /ai/integrations/connections/{user_connection_id},GET /ai/integrations/{integration_id})。
使用方式 所有请求发送至 https://api.telnyx.com/v2/ 下的对应端点,使用 curl 的 -X 指定方法、-H 设置认证与内容类型、-d 传入 JSON 请求体。示例中提供了检查 HTTP 状态码的写法:使用 curl -s -w "\n%{http_code}" 获取响应体与状态码,再通过 case 分支处理 2*、422、429、401 等情形。
错误处理 常见错误码:401 无效 API 密钥,403 权限不足,404 资源未找到,422 验证错误(检查字段格式),429 触发速率限制(建议延迟重试,示例中使用 sleep 1)。生产代码应始终处理网络错误、速率限制、验证错误和认证错误。
分页 列表端点返回分页结果,使用 page[number] 和 page[size] 查询参数翻页,并检查响应中的 meta.total_pages。
适用场景 适用于需要通过脚本或命令行自动化管理 Telnyx 网络资源、Global IP 及其健康与用量监控,以及调用 Telnyx AI 集群与集成接口的场景。
限制 资料未提供各接口的速率限制具体数值、配额、计费方式、价格、平台支持范围之外的信息,也未提供除 curl 之外的语言示例;部分接口的必填与可选字段以资料所列内容为准,缺失信息暂未提供。