跳到主要内容

URL​

https://api.decoo-cloud.cn/pinning/pinJobs

描述​

获取当前用户的 Pin Job 列表。

请求类型​

GET

Headers​

"Authorization": "Bearer <YOUR_API_KEY>"

Request​

可以通过一些参数来对查询结果进行过滤：

  • pin-hash: 只获取指定 CID 的 Pin Job。

  • sort: 对查询结果按照日期进行排序。

    • ASC: 升序排列。
    • DESC: 降序排列 (默认行为)。

  • status: 只返回指定状态的 Pin Job。如果未指定，则所有状态的 Job 都会返回。Pin Job 可能的状态如下：

    • queued: Job 已创建，但是 Baitech Storage 尚未处理。
    • pinning: Job 正在被 Baitech Storage 处理。
    • pinned: Job 处理成功，文件已成功存储至 IPFS。
    • failed: Job 处理失败。失败的 Job 在24小时之内会被尝试重新处理，如果成功则状态会更新。

  • offset: 分页获取的起始下标，默认为0。

  • limit: 分页获取的数量，默认为5，最大值为1000。

Response​

{
  "Count": "<Pin Job 的数量 (根据查询条件)>",
  "Jobs": [
    {
      "Id": "<Job Id>",
      "Status": "<Job 状态>",
      "PinHash": "<Job 对应的文件 CID>"
    },
    {
      ...
    }
  ]
}

Curl 请求示例​

curl -X GET "https://api.decoo-cloud.cn/pinning/pinJobs?sort=DESC&status=queued&offset=0&limit=10" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json"