✨
Singularity
한국어
한국어
  • 개요
    • Singularity란
    • V1 또는 V2
  • 설치
    • 바이너리 파일 다운로드
    • 도커를 통한 설치
    • 소스 코드에서 빌드
    • 운영 환경에 배포
  • 데이터 준비
    • 시작하기
    • 성능 조정
  • 콘텐츠 배포
    • CAR 파일 배포하기
  • 거래 수립
    • 거래 일정 만들기
  • 주제
    • 인라인 준비
    • 벤치마크
  • 💻CLI 참조
    • 메뉴
    • Ez Prep
    • 버전
    • 관리자
      • 초기화
      • 재설정
      • 데이터셋 이전
      • 일정 이전
    • 다운로드
    • 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
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • 기타
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 기존
          • 새로 만들기
        • Sugarsync
        • 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
          • Alibaba
          • Arvancloud
          • Ceph
          • Chinamobile
          • Cloudflare
          • Digitalocean
          • Dreamhost
          • Huaweiobs
          • Ibmcos
          • Idrive
          • Ionos
          • Liara
          • Lyvecloud
          • Minio
          • Netease
          • 기타
          • Qiniu
          • Rackcorp
          • Scaleway
          • Seaweedfs
          • Stackpath
          • Storj
          • Tencentcos
          • Wasabi
        • Seafile
        • Sftp
        • Sharefile
        • Sia
        • Smb
        • Storj
          • 기존
          • 새로 만들기
        • Sugarsync
        • Swift
        • Uptobox
        • Webdav
        • Yandex
        • Zoho
      • 이름 변경
    • Prep
      • 생성
      • 목록
      • 상태
      • 이름 변경
      • 소스 연결
      • 출력 연결
      • 출력 분리
      • 스캔 시작
      • 스캔 일시 중지
      • 팩 생성 시작
      • 팩 일시 중지
      • Daggen 시작
      • Daggen 일시 중지
      • 조각 목록
      • 조각 추가
      • 탐색
      • 월렛 연결
      • 월렛 목록
      • 월렛 분리
  • 🌐웹 API 참조
    • 거래 일정
    • 거래
    • 파일
    • 작업
    • 조각
    • 준비 작업
    • 저장소
    • 월렛 연결
    • 월렛
    • 사양
  • ❓FAQ
    • 데이터베이스가 잠김
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. 웹 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"
}