矩池云开放API
    矩池云开放API
    • PaaS API
      • 新增任务
        POST
      • 查询单个任务详情
        GET
      • 查询所有任务状态
        GET
      • 查询所有任务详情
        GET
      • 取消任务
        DELETE

    PaaS API

    矩池云 PaaS API 为用户提供了从创建任务到获取任务结果的一系列接口,用户可以选择配置好的环境作为任务运行环境,通过命令启动并运行存放在矩池云网盘或环境中的任务代码,并获取任务运行状态及按照状态的任务统计数据,当监测到任务出现问题时,也可提前结束任务。
    矩池云为任务操作提供的 API 包括:
    创建任务
    获取所有任务的状态
    获取单个任务的具体信息
    取消任务
    查询余量

    接入指南#

    注意:
    当前 API 仅支持 http 调用,暂不支持 https,所以最佳的调用方式是通过服务端代码进行调用,不建议在浏览器端进行直接调用。

    接口鉴权#

    接口需要鉴权,通过 HTTP 的 Authorization 字段传递 token 进行鉴权,token 的获取可以参考获取和使用 Token,即在接口请求的 http header 中包含 Authorization: Bearer <Your Token>。

    获取和使用Token#

    获取Token
    当前矩池云开放 API 处于 Beta 阶段,有此需求的用户可以通过以下任意任意一种方式联系我们以获取 Token:
    支持微信:矩池云小助手 (处理周期:3小时内)
    使用Token
    在您获取到 Token 后,有以下两种方式进行接口鉴权:
    Token 通过 HTTP Header 传输:在每次发送 HTTP 请求的时候,通过设置 HTTP Header 中的 Authorization 字段来进行接口鉴权,即在 HTTP Header 中包含 Authorization: Bearer <Your Token>(注意空格)。
    Token 通过 HTTP Query 参数传输:在每次发送 HTTP 请求的时候,通过设置 HTTP Query 参数中的 Authorization 字段来进行接口鉴权,即在 HTTP Query 参数中包含 Authorization=Bearer%20<Your Token>(注意空格被 URL 编码成 %20)。
    如果同时使用两种方式传输 token,以 Query 参数中的 token 为准。
    Token默认有效期1个月,到期后请联系我们续时

    全局错误码#

    在接口返回 200 的 HTTP Code 情况下,Response Body 会有一个 code 字段指示本次接口请求的业务状态(正常或异常),以下列表指明了该 code 字段可能的值和含义。
    code含义
    0正常,符合预期
    1内部错误,非列表中错误,查看返回的 msg 字段获取更多信息
    6请求参数错误,请检查请求参数是否和文档中描述一致
    7鉴权失败,检查是否传入了 token,token 是否过期
    下一页
    新增任务
    Built with