8.4.17 显示IPFS固定对象接口
通过此接口可以列出IPFS网络中已经被固定到本地存储的对象列表。
1. 接口地址：https://节点网关地址/ipfs/[peer名称]/下载key/api/v0/pin/ls
2. 通讯方式：POST
3. 请求参数
| 序号 | 字段名 | 字段 | 类型 | 必填 | 备 注 |
|---|---|---|---|---|---|
| 1 | IPFS路径 | arg | string | Y | 要锁定的对象路径 |
| 2 | 键锁定类型 | type | string | N | 要列出的锁定键的类型direct：直接的indirect：间接的recursive：递归的all：所有类型，此字段如果根据类型进行查询，必须传已经存在锁定键的类型。 |
| 3 | 是否仅输出对象哈希 | stream | bool | N | 是否仅输出对象的哈希值 |
示例
// POST
Curl
"https:// 网关地址/ipfs/下载key /api/v0/pin/ls?arg=QmTStHSziV4cfuYaHKbRYnmBb5XCzdj67kV7jNvbKKr2qv&type=all&quiet=true&stream=true
-X POST \
-H "Content-Type: multipart/form-data" \
-F file=@"/sample-result.json”
4. 响应参数
| 序号 | 字段名 | 字段 | 类型 | 备注 |
|---|---|---|---|---|
| stream参数为true | ||||
| 1 | CID | CID | string | |
| 2 | 键锁定类型 | Type | string | |
| stream参数为false | ||||
| 1 | 键值数据列表 | Keys | []Key | |
| Key | ||||
| 1 | CID | CID | string | |
| 2 | 键锁定类型 | Type | string |
示例
stream参数为true：
{
"Cid": "QmTStHSziV4cfuYaHKbRYnmBb5XCzdj67kV7jNvbKKr2qv",
"Type": "recursive"
}
stream参数为false：
{
"Keys": {
"QmTStHSziV4cfuYaHKbRYnmBb5XCzdj67kV7jNvbKKr2qv": {
"Type": "recursive"
}
}
}