Open API 使用文档

版本说明：自 v1.2.0 起，平台正式上线 Open API 功能。用户可通过 API 接口灵活管理和调度任务资源，实现自动化与集成化运维。

本文档将指导您完成 API 密钥获取、鉴权配置及接口调试。详细的接口参数定义请参考 Open API 在线调试文档。

1. API 密钥类型与选择

在获取密钥前，请根据您的业务需求选择适合的密钥模式：

快速模式

• 特点：仅需填写备注，系统自动生成 Token。
• 适用场景：开发调试、内部简单集成。
• 备注：无需签名，直接调用。

RSA 模式

• 特点：需填写备注及公钥。
• 适用场景：生产环境、对安全性要求高。
• 备注：平台仅保存公钥，私钥请自行妥善保管。调用时需进行 RSA 签名。

安全提示：为保障账户安全，密钥（Token 或 RSA 私钥信息）仅在创建时展示一次。请务必在创建后立即复制并安全存储。如不慎丢失，只能重新创建。

2. 密钥获取与配置流程

第一步：生成密钥

1. 登录共绩算力个人中心后台。
2. 访问 API 密钥管理页面：https://console.suanli.cn/settings/key
3. 点击 “新建密钥”，选择模式并生成。
4. 立即复制生成的密钥信息。

第二步：在线调试 (推荐)

建议在正式集成前，使用在线工具验证接口连通性。

1. 进入 Open API 在线接口调试页面 并点击 【调试】。

2. 在 Header 参数区域配置鉴权信息：

   • token: 填写刚才获取的 API 密钥。
   • version & timestamp: 使用调试界面默认值即可。

3. 点击 发送 发起请求。

3. 接口鉴权说明

在实际代码调用中，所有请求均需在 HTTP Header 中包含鉴权参数。

快速模式鉴权

无需复杂的签名算法，直接传递 Token 即可。

Header 参数示例：

JSON

{
  "token": "your-api-token-here",
  "timestamp": "1700000000",
  "version": "1.2.0"
}

RSA 模式鉴权

需要使用您的私钥对请求进行签名。详细的签名生成规则及算法，请查阅独立的 API 加签文档。

FAQ

Q：如何实现自定义负载均衡策略？

A： 平台支持灵活的节点映射。

每个 API 任务都会生成一个独立的自定义服务地址（HTTPS 协议）。您可以通过 API 批量下发单节点任务，建立“1 个任务节点 = 1 个服务地址”的映射关系。获取这些地址后，您可以在自己的网关层或客户端自由配置负载均衡算法（如轮询、随机等）来分发流量。