共绩科技
  1. 任务
共绩科技
  • 共绩算力 Open API
    • 任务
      • 显卡资源查询接口
        GET
      • 任务创建接口
        POST
      • 任务列表查询接口
        GET
      • 任务详情查询接口
        GET
      • 任务暂停接口
        POST
      • 任务删除接口
        POST
      • 任务恢复接口
        POST
      • 任务修改接口
        POST
      • 任务自定义YAML校验接口
        POST
    • 节点
      • 任务节点列表查询接口
      • 任务节点数量修改接口
      • 任务节点删除接口
      • 任务节点关机接口
      • 获取任务节点日志
      • 获取任务Pod事件
    • 计费管理
      • 获取计费记录
    • 存储
      • 存储配置列表
  1. 任务

任务创建接口

POST
/api/deployment/task/create
任务创建接口，资源信息需要通过 "显卡资源查询接口" 获取（mark标识）。 如果使用了不存在的资源类型（mark标识），尽管接口会返回成功，GUI面板上也能看到任务被成功创建，但是因为实际资源不存在，任务无法匹配到GPU，Pod不会被分配，亦不会扣费。 services数组目前仅支持定义单个service，因而，建议service_name设置为和task_name相同。实例名称只能是 小写字母开头的（大小写字母,数字,中横线）
API 加验签说明
根据 API 密钥模式，支持两种调用方式：
快速模式：仅需在 Header 中传递 token 参数
RSA 模式：需要 RSA 签名验证，需额外传递 token、timestamp、version、sign_str 参数。
签名生成步骤
1.
构建待签名字符串：
path: 接口地址（如：/api/deployment/task/create）
version: 请求头中的接口版本（如：1.0.0）
timestamp: 请求头中的时间戳（毫秒）
token: 请求头中的 token
data: 接口请求体 JSON 字符串
2.
使用 RSA-SHA256 算法对待签名字符串进行签名
3.
将签名结果转换为 Base64 字符串
4.
将 Base64 签名字符串设置到请求头的 sign_str 字段。
注意事项： - 签名字符串中各参数用换行符 \n 连接 - 如果请求体需要加密，则 data 为加密后的 Base64 字符串 - 同时需要加密和加签时，必须先进行加密步骤，再进行加签步骤
自定义 YAML 导入功能说明
此接口支持通过自定义 YAML 配置来创建任务，提供灵活的容器部署方案：
功能特性
自定义容器配置：支持完整的 Kubernetes Pod 配置 - 资源限制设置：可自定义 CPU、内存、GPU 等资源请求和限制 - 环境变量配置：支持容器环境变量设置 - 端口映射：支持容器端口配置 - 存储挂载：支持持久化存储配置 - 安全验证：支持 YAML 配置签名校验
使用流程
1.
准备 YAML 配置
创建符合 Kubernetes 规范的 Pod 配置文件
2.
配置签名校验
通过 YAML 校验接口验证配置的有效性和完整性
3.
创建任务
将验证通过的 YAML 配置提交
配置示例
Deployment 配置示例：

请求参数

Header 参数

Body 参数application/json

示例
{
    "task_name": "test-task",
    "resources": [
        {
            "mark": "your_resource_mark"
        }
    ],
    "points": 1,
    "services": [
        {
            "service_name": "test-service",
            "service_image": "harbor.suanleme.cn/library/ffmpeg-api:cpu",
            "remote_ports": [
                {
                    "service_port": 8000
                }
            ],
            "env": null,
            "storage_config": null,
            "custom_yaml": null
        }
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://openapi.suanli.cn/api/deployment/task/create' \
--header 'token: your_api_token_here' \
--header 'timestamp: 1747379023000' \
--header 'version: 1.0.0' \
--header 'sign_str: base64_encoded_signature_here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "task_name": "test-task",
    "resources": [
        {
            "mark": "your_resource_mark"
        }
    ],
    "points": 1,
    "services": [
        {
            "service_name": "test-service",
            "service_image": "harbor.suanleme.cn/library/ffmpeg-api:cpu",
            "remote_ports": [
                {
                    "service_port": 8000
                }
            ],
            "env": null,
            "storage_config": null,
            "custom_yaml": null
        }
    ]
}'

返回响应

🟢200成功
application/json
请求成功
Body

示例
{
    "code": "0000",
    "message": "success",
    "data": {
        "task_id": 504
    }
}
🟠400请求有误
🟠401没有权限
🔴500服务器错误
修改于 2025-09-10 06:34:50
上一页
显卡资源查询接口
下一页
任务列表查询接口
Built with