작업

Pack a pack job into car files

POST//localhost:9090/api/job/{id}/pack
Path parameters
id*integer

Pack job ID

Response

OK

Body
attachmentIdinteger
createdAtstring
fileSizeinteger
idinteger
jobIdinteger
numOfFilesinteger
pieceCidstring
pieceSizeinteger
preparationIdinteger

Association

rootCidstring
storageIdinteger
storagePathstring

StoragePath is the path to the CAR file inside the storage. If the StorageID is nil but StoragePath is not empty, it means the CAR file is stored at the local absolute path.

Request
const response = await fetch('//localhost:9090/api/job/{id}/pack', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "attachmentId": 0,
  "createdAt": "text",
  "fileSize": 0,
  "id": 0,
  "jobId": 0,
  "numOfFiles": 0,
  "pieceCid": "text",
  "pieceSize": 0,
  "preparationId": 0,
  "rootCid": "text",
  "storageId": 0,
  "storagePath": "text"
}

prepare to pack a data source

POST//localhost:9090/api/preparation/{id}/source/{name}/finalize
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

Response

No Content

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/finalize', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
text

Pause an ongoing DAG generation job

POST//localhost:9090/api/preparation/{id}/source/{name}/pause-daggen
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/pause-daggen', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "attachmentId": 0,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 0,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Pause a specific packing job

POST//localhost:9090/api/preparation/{id}/source/{name}/pause-pack/{job_id}
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

job_id*integer

Pack Job ID

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/pause-pack/{job_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "attachmentId": 0,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 0,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Pause an ongoing scanning job

POST//localhost:9090/api/preparation/{id}/source/{name}/pause-scan
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/pause-scan', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "attachmentId": 0,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 0,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start a new DAG generation job

POST//localhost:9090/api/preparation/{id}/source/{name}/start-daggen
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/start-daggen', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "attachmentId": 0,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 0,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}

Start or restart a specific packing job

POST//localhost:9090/api/preparation/{id}/source/{name}/start-pack/{job_id}
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

job_id*integer

Pack Job ID

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/start-pack/{job_id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "attachmentId": 0,
    "errorMessage": "text",
    "errorStackTrace": "text",
    "id": 0,
    "state": "created",
    "type": "scan",
    "workerId": "text"
  }
]

Start a new scanning job

POST//localhost:9090/api/preparation/{id}/source/{name}/start-scan
Path parameters
id*string

Preparation ID or name

name*string

Storage ID or name

Response

OK

Body
attachmentIdinteger
errorMessagestring
errorStackTracestring
idinteger
statemodel.JobState (enum)
createdreadypausedprocessingcompleteerror
typemodel.JobType (enum)
scanpackdaggen
workerIdstring

Associations

Request
const response = await fetch('//localhost:9090/api/preparation/{id}/source/{name}/start-scan', {
    method: 'POST',
    headers: {},
});
const data = await response.json();
Response
{
  "attachmentId": 0,
  "errorMessage": "text",
  "errorStackTrace": "text",
  "id": 0,
  "state": "created",
  "type": "scan",
  "workerId": "text"
}
Previous파일Next조각

Last updated