✨
Singularity
中文
中文
  • 概述
    • 什么是Singularity
    • V1或V2
  • 安装
    • 下载二进制文件
    • 通过Docker安装
    • 从源代码构建
    • 部署到生产环境
  • 数据准备
    • 快速入门
    • 性能调优
  • 内容分发
    • 分发CAR文件
  • 交易处理
    • 创建交易计划
  • 主题
    • 内嵌准备
    • 基准测试
  • 💻CLI 参考
    • 菜单
    • Ez准备
    • 版本
    • 管理员
      • 初始化
      • 重置
      • 迁移数据集
      • 迁移计划
    • 下载
    • 提取Car
    • 交易
      • 计划
        • 创建
        • 列表
        • 更新
        • 暂停
        • 恢复
      • 手动发送
      • 列表
    • 运行
      • API
      • 数据集处理器
      • 内容提供者
      • 交易跟踪器
      • 交易发布者
      • 下载服务器
    • 钱包
      • 导入
      • 列表
      • 删除
    • 存储
      • 创建
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • 其他
        • 本地
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3和兼容存储
          • Aws
          • 阿里云
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • 华为云
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • 网易云
          • 其他
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • 腾讯云
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 已存在
          • 新建
        • 蓝奏云
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • 浏览
      • 列表
      • 删除
      • 更新
        • Acd
        • Azureblob
        • B2
        • Box
        • Drive
        • Dropbox
        • Fichier
        • Filefabric
        • Ftp
        • Google Cloud Storage
        • Gphotos
        • Hdfs
        • Hidrive
        • Http
        • Internetarchive
        • Jottacloud
        • Koofr / Digi Storage
          • Digistorage
          • Koofr / Digi Storage
          • 其他
        • 本地
        • Mailru
        • Mega
        • Netstorage
        • Onedrive
        • Opendrive
        • Oos
          • Env_auth
          • Instance_principal_auth
          • No_auth
          • Resource_principal_auth
          • User_principal_auth
        • Pcloud
        • Premiumizeme
        • Putio
        • Qingstor
        • AWS S3和兼容存储
          • Aws
          • 阿里云
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • 华为云
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • 网易云
          • 其他
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • 腾讯云
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 已存在
          • 新建
        • 蓝奏云
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • 重命名
    • 准备
      • 创建
      • 列表
      • 状态
      • 重命名
      • 附加来源
      • 附加输出
      • 分离输出
      • 开始扫描
      • 暂停扫描
      • 开始打包
      • 暂停打包
      • 开始Daggen
      • 暂停Daggen
      • 列表片段
      • 添加片段
      • 浏览
      • 附加钱包
      • 列表钱包
      • 分离钱包
  • 🌐Web API 参考
    • 交易计划
    • 交易
    • 文件
    • 作业
    • 片段
    • 准备
    • 存储
    • 钱包关联
    • 钱包
    • 规范
  • ❓常见问题
    • 数据库已锁定
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Web API 参考

交易计划

Previous分离钱包Next交易

Last updated 1 year ago

Was this helpful?

🌐

Pause a specific schedule

post
Path parameters
idintegerRequired

Schedule ID

Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/schedule/{id}/pause HTTP/1.1
Host: localhost:9090
Accept: */*
{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}

Resume a specific schedule

post
Path parameters
idintegerRequired

Schedule ID

Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/schedule/{id}/resume HTTP/1.1
Host: localhost:9090
Accept: */*
{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}
  • GETList all schedules for a preparation
  • POSTCreate a new schedule
  • POSTPause a specific schedule
  • POSTResume a specific schedule

List all schedules for a preparation

get
Path parameters
idstringRequired

Preparation ID or name

Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
get
GET /api/preparation/{id}/schedules HTTP/1.1
Host: localhost:9090
Accept: */*
[
  {
    "allowedPieceCids": [
      "text"
    ],
    "announceToIpni": true,
    "createdAt": "text",
    "duration": 1,
    "errorMessage": "text",
    "force": true,
    "httpHeaders": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": 1,
    "keepUnsealed": true,
    "maxPendingDealNumber": 1,
    "maxPendingDealSize": 1,
    "notes": "text",
    "preparationId": 1,
    "pricePerDeal": 1,
    "pricePerGb": 1,
    "pricePerGbEpoch": 1,
    "provider": "text",
    "scheduleCron": "text",
    "scheduleCronPerpetual": true,
    "scheduleDealNumber": 1,
    "scheduleDealSize": 1,
    "startDelay": 1,
    "state": "active",
    "totalDealNumber": 1,
    "totalDealSize": 1,
    "updatedAt": "text",
    "urlTemplate": "text",
    "verified": true
  }
]

Create a new schedule

post

Create a new schedule

Body
allowedPieceCidsstring[]Optional

Allowed piece CIDs in this schedule

durationstringOptional

Duration in epoch or in duration format, i.e. 1500000, 2400h

Default: 12840h
forcebooleanOptional

Force to send out deals regardless of replication restriction

httpHeadersstring[]Optional

http headers to be passed with the request (i.e. key=value)

ipnibooleanOptional

Whether the deal should be IPNI

Default: true
keepUnsealedbooleanOptional

Whether the deal should be kept unsealed

Default: true
maxPendingDealNumberintegerOptional

Max pending deal number

maxPendingDealSizestringOptional

Max pending deal size in human readable format, i.e. 100 TiB

notesstringOptional

Notes

preparationstringOptional

Preparation ID or name

pricePerDealnumberOptional

Price in FIL per deal

Default: 0
pricePerGbnumberOptional

Price in FIL per GiB

Default: 0
pricePerGbEpochnumberOptional

Price in FIL per GiB per epoch

Default: 0
providerstringOptional

Provider

scheduleCronstringOptional

Schedule cron pattern

scheduleCronPerpetualbooleanOptional

Whether a cron schedule should run in definitely

scheduleDealNumberintegerOptional

Number of deals per scheduled time

scheduleDealSizestringOptional

Size of deals per schedule trigger in human readable format, i.e. 100 TiB

startDelaystringOptional

Deal start delay in epoch or in duration format, i.e. 1000, 72h

Default: 72h
totalDealNumberintegerOptional

Total number of deals

totalDealSizestringOptional

Total size of deals in human readable format, i.e. 100 TiB

urlTemplatestringOptional

URL template with PIECE_CID placeholder for boost to fetch the CAR file, i.e. http://127.0.0.1/piece/{PIECE_CID}.car

verifiedbooleanOptional

Whether the deal should be verified

Default: true
Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/schedule HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 474

{
  "allowedPieceCids": [
    "text"
  ],
  "duration": "text",
  "force": true,
  "httpHeaders": [
    "text"
  ],
  "ipni": true,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": "text",
  "notes": "text",
  "preparation": "text",
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": "text",
  "startDelay": "text",
  "totalDealNumber": 1,
  "totalDealSize": "text",
  "urlTemplate": "text",
  "verified": true
}
{
  "allowedPieceCids": [
    "text"
  ],
  "announceToIpni": true,
  "createdAt": "text",
  "duration": 1,
  "errorMessage": "text",
  "force": true,
  "httpHeaders": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "keepUnsealed": true,
  "maxPendingDealNumber": 1,
  "maxPendingDealSize": 1,
  "notes": "text",
  "preparationId": 1,
  "pricePerDeal": 1,
  "pricePerGb": 1,
  "pricePerGbEpoch": 1,
  "provider": "text",
  "scheduleCron": "text",
  "scheduleCronPerpetual": true,
  "scheduleDealNumber": 1,
  "scheduleDealSize": 1,
  "startDelay": 1,
  "state": "active",
  "totalDealNumber": 1,
  "totalDealSize": 1,
  "updatedAt": "text",
  "urlTemplate": "text",
  "verified": true
}