Open API 使用文档
自 1.2.0 版本起,平台正式上线 Open API 功能,用户可通过 API 接口灵活管理和调度任务资源,实现自动化与集成化运维。以下文档将介绍 API 密钥获取、接口参数说明及典型使用流程。
API 密钥获取与使用流程
在调用 API 前,需先获取 API 密钥,并在调试或实际调用时通过 Header 传递 Token 参数。
- 登录共绩算力个人中心后台。
- 进入 https://console.suanli.cn/settings/key API 密钥管理页面。
- 点击"新建密钥"生成并复制 API 密钥(默认快速模式)。
- 在"接口参数文档"页面,点击【调试】。
- 在 Header 区域添加
token
参数,参数值为刚刚生成的 API 密钥。 - 发起接口请求。
API 密钥类型与使用提示
API 密钥分为快速模式和 RSA 模式两种类型,可根据实际需求选择:
快速模式:仅需填写备注,系统自动生成 API Key,可直接调用接口。
RSA 模式:填写备注 + 公钥,系统自动生成其他信息。平台仅保存公钥,请妥善保管其他信息,遗失后无法找回,只能重新生成。调用 API 需要进行签名。详细签名规则请参考 API 加签文档。
⚠️ 安全提示:为降低密钥泄漏的风险,密钥创建后仅会展示一次,请及时保存。如果丢失,需要重新创建新的密钥。
接口鉴权
快速模式密钥无需签名,直接在 Header 中添加 token
参数即可调用接口。
text
headers = {"token": "填写你获取的 token 值"}
RSA 模式密钥需要签名,详细签名规则请参考 API 加签文档。
接口参数文档
https://apifox.com/apidoc/shared/6aa360d3-d8f2-471e-b841-3a35c33a7b7c
接口基本流程
