Ghim

Ghim nội dung IPFS hiện có vào tài khoản của bạn. Khi bạn ghim một CID, cụm của chúng tôi tìm nạp nội dung từ mạng IPFS và giữ nó khả dụng vĩnh viễn.

Ghim theo CID

POST /pin

Tham số	Kiểu	Bắt buộc	Mô tả
`cid`	string	Có	Mã định danh nội dung IPFS (bắt đầu bằng `Qm` hoặc `bafy`).
`description`	string	Không	Mô tả ngắn để bạn tham khảo.
`metadata`	object	Không	Cặp khóa-giá trị tùy chỉnh để đính kèm vào pin. Tối đa 10 khóa. Khóa phải là chữ và số hoặc dấu gạch dưới, 1-64 ký tự. Giá trị phải là chuỗi, tối đa 256 ký tự. Tổng kích thước siêu dữ liệu không được vượt quá 4 KB.

Ví dụ yêu cầu

bash

curl -X POST https://api.ipfs.ninja/pin \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "description": "NFT metadata",
    "metadata": {
      "collection": "my-nfts",
      "token_id": "42"
    }
  }'

Phản hồi `202 Accepted`

json

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinning",
  "description": "NFT metadata",
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

TIP

Ghim là bất đồng bộ. Phản hồi trả về ngay lập tức với trạng thái pinning. Thăm dò endpoint trạng thái để kiểm tra khi ghim hoàn tất.

Kiểm tra Trạng thái Ghim

GET /pin/:cid

Tham số	Kiểu	Bắt buộc	Mô tả
`cid`	string	Có	CID bạn đang kiểm tra.

Phản hồi `200 OK`

json

{
  "cid": "QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
  "status": "pinned",
  "sizeMB": 0.042,
  "fileName": "NFT metadata",
  "pinnedAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F",
    "url": "https://ipfs.ninja/ipfs/QmXk7VRz4qoG5Dg8sFL4bYWHpKe4F"
  }
}

Giá trị trạng thái

Trạng thái	Ý nghĩa
`pinning`	Nội dung đang được tìm nạp từ mạng IPFS. Thăm dò lại sau vài giây.
`pinned`	Nội dung đã được ghim và khả dụng qua tài khoản và gateway.
`failed`	Không tìm thấy nội dung trên mạng IPFS. CID có thể không hợp lệ hoặc nội dung không còn khả dụng.

Cách ghim hoạt động

Bạn gửi CID qua POST /pin
Cụm IPFS tìm kiếm trên mạng các nút có nội dung
Cụm tải xuống và ghim nội dung cục bộ
Sau khi ghim, tệp xuất hiện trong danh sách tệp và có thể truy cập qua gateway
Mức sử dụng dung lượng được ghi nhận khi ghim hoàn tất

WARNING

Thời gian ghim phụ thuộc vào kích thước tệp và tính khả dụng trên mạng. Các tệp nhỏ thường được ghim trong vài giây. Tệp lớn hoặc nội dung hiếm khi được ghim có thể mất vài phút.

Dung lượng lưu trữ

Nội dung đã ghim được tính vào giới hạn lưu trữ của gói. Kích thước tệp được ghi nhận khi ghim hoàn tất -- bạn có thể bắt đầu ghim ngay cả khi dung lượng gần đạt giới hạn, nhưng các lần tải lên tiếp theo sẽ bị chặn nếu pin làm vượt giới hạn.

Ghim ​

Ghim theo CID ​

Ví dụ yêu cầu ​

Phản hồi 202 Accepted ​

Kiểm tra Trạng thái Ghim ​

Phản hồi 200 OK ​

Giá trị trạng thái ​

Cách ghim hoạt động ​

Dung lượng lưu trữ ​