✨
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?

🌐

Get metadata for a piece

get

Get metadata for a piece for how it may be reassembled from the data source

Path parameters
idstringRequired

Piece CID

Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
404
Not Found
application/json
500
Internal Server Error
application/json
get
GET /api/piece/{id}/metadata HTTP/1.1
Host: localhost:9090
Accept: */*
{}

List all prepared pieces 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}/piece HTTP/1.1
Host: localhost:9090
Accept: */*
[
  {
    "attachmentId": 1,
    "pieces": [
      {
        "attachmentId": 1,
        "createdAt": "text",
        "fileSize": 1,
        "id": 1,
        "jobId": 1,
        "numOfFiles": 1,
        "pieceCid": "text",
        "pieceSize": 1,
        "preparationId": 1,
        "rootCid": "text",
        "storageId": 1,
        "storagePath": "text"
      }
    ],
    "source": {
      "clientConfig": {
        "caCert": [
          "text"
        ],
        "clientCert": "text",
        "clientKey": "text",
        "connectTimeout": 1,
        "disableHttp2": true,
        "disableHttpKeepAlives": true,
        "expectContinueTimeout": 1,
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "insecureSkipVerify": true,
        "lowlevelRetries": 1,
        "noGzip": true,
        "retryBackoff": 1,
        "retryBackoffExponential": 1,
        "retryDelay": 1,
        "retryMaxCount": 1,
        "scanConcurrency": 1,
        "skipInaccessibleFile": true,
        "timeout": 1,
        "useServerModTime": true,
        "userAgent": "text"
      },
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "createdAt": "text",
      "id": 1,
      "name": "text",
      "path": "text",
      "preparationsAsOutput": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "preparationsAsSource": [
        {
          "createdAt": "text",
          "deleteAfterExport": true,
          "id": 1,
          "maxSize": 1,
          "name": "text",
          "noDag": true,
          "noInline": true,
          "outputStorages": [
            "[Circular Reference]"
          ],
          "pieceSize": 1,
          "sourceStorages": [
            "[Circular Reference]"
          ],
          "updatedAt": "text"
        }
      ],
      "type": "text",
      "updatedAt": "text"
    },
    "storageId": 1
  }
]
  • GETGet metadata for a piece
  • GETList all prepared pieces for a preparation
  • POSTAdd a piece to a preparation

Add a piece to a preparation

post
Path parameters
idstringRequired

Preparation ID or name

Body
fileSizeintegerOptional

File size of the CAR file, this is required for boost online deal

pieceCidstringRequired

CID of the piece

pieceSizestringRequired

Size of the piece

rootCidstringOptional

Root CID of the CAR file, used to populate the label field of storage deal

Responses
200
OK
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /api/preparation/{id}/piece HTTP/1.1
Host: localhost:9090
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "fileSize": 1,
  "pieceCid": "text",
  "pieceSize": "text",
  "rootCid": "text"
}
{
  "attachmentId": 1,
  "createdAt": "text",
  "fileSize": 1,
  "id": 1,
  "jobId": 1,
  "numOfFiles": 1,
  "pieceCid": "text",
  "pieceSize": 1,
  "preparationId": 1,
  "rootCid": "text",
  "storageId": 1,
  "storagePath": "text"
}