API 文档更新说明

发布时间:2025-12-16 17:53

使用 API 管理云资源的用户可以留意一下，顺云开发者文档近期完成了一次更新，新增了若干查询类接口，鉴权说明与示例代码也补充得更完整。本次 API 文档更新不涉及已有接口的字段变更，现有脚本无需改动。 ## 新增了哪些接口 新增接口集中在查询类：实例列表与详情查询、流量与带宽用量查询、操作日志查询。变更类接口此前已经提供，本次未做调整。查询能力补齐后，日常巡检脚本、费用对账脚本需要的数据基本都能从接口直接取到，不必再登录控制台逐页核对，之前靠手工拼参数的做法也可以收起来了，分页、排序字段在参数说明里都列了出来。接口调用频率限制的说明也一并列出，超限会返回限流错误，脚本里加个重试间隔即可。 ## 鉴权说明 文档把鉴权流程单独抽成一节，覆盖签名算法、时间戳格式、编码方式三项。常见错误是服务器时间偏差过大导致鉴权失败，返回 401，处理办法是先校验系统时间，用 chrony 或 ntpdate 同步后再试。请求示例（域名与路径以文档实际标注为准）： curl -s "https://api.soonyun.com/v1/instances" \ -H "Authorization: Bearer <你的AccessKey>" ## 示例代码怎么用 每个接口都补了请求与响应示例，响应字段逐个标注含义，示例可以直接复制修改，替换密钥后即可运行。以实例列表接口为例，返回体包含实例 ID、状态、规格、到期时间，写监控脚本时可以直接读 status 字段做异常判断，读到到期时间字段可以提前七天触发续费提醒。 ## 遇到问题怎么办 文档入口在控制台的开发者中心。如果发现示例跑不通，或字段描述与实际返回不一致，欢迎通过官网工单或在线客服反馈，写明接口路径与请求参数，文档团队会跟进核实修订。同时建议收藏文档站的更新记录页，每次变更都会留痕，便于回查某个字段是否调整过。