8.4.2 获取所有数据块列表接口
通过调用此接口可以获取所有的数据块列表。
1. 接口地址：https://节点网关地址/ipfs/[peer名称]/下载key/api/v0/ls
2. 通讯方式： POST
3. 请求参数
| 序号 | 字段名 | 字段 | 类型 | 必填 | 备 注 |
|---|---|---|---|---|---|
| 1 | IPFS路径 | arg | string | Y | 要输出的对象的路径，此值为文件CID或文件哈希值 |
| 2 | 是否输出表头 | headers | bool | N | |
| 3 | 是否解析链接对象 | resolve-type | bool | N | 是否解析链接的对象来检测其数据类型，当resolve-type参数设置为true时，则表示强制显示分片大小和类型。 |
| 4 | 显示所有信息 | size | bool | N | 是否显示所有信息，当resolve-type参数设置为true时，此参数设置将会标记为无效，当stream参数设置为false时，设置size为true时，则会显示大小和类型，反之则不会显示 |
| 5 | 是否启用流式传输 | stream | bool | N | 在遍历目录项时启用实验性的流式传输，此字段必须为true |
示例
// POST
curl
"https://网关地址/ipfs/下载key/api/v0 /ls?arg=QmY2Pp7vcCgD5vw6oXn3HSxeAeDa2eujEaRSKGTA4BZUXB&headers=false&resolve-type=false&size=true "
4. 响应参数
| 序号 | 字段名 | 字段 | 类型 | 备注 |
|---|---|---|---|---|
| 1 | 对象列表 | Objects | []Object | |
| Object | ||||
| 1 | CID | Hash | string | |
| 2 | 链接列表 | Links | []Link | |
| Link | ||||
| 1 | 数据块名称 | Name | string | |
| 2 | 数据块哈希 | Hash | string | |
| 3 | 数据块大小 | Size | int | 此响应参数会根据请求参数的resolve-type和size共同决定是否返回 |
| 4 | 数据块类型 | Type | int | 此响应参数会根据请求参数的resolve-type和size共同决定是否返回 |
| 5 | 目标信息 | Target | string |
示例
{
"Objects": [
{
"Hash": "QmY2Pp7vcCgD5vw6oXn3HSxeAeDa2eujEaRSKGTA4BZUXB",
"Links": [
{
"Name": "",
"Hash": "QmaviNBByTz2sSM5eqEtK5nhsqazo7XYiJkK9BqTCxHUgh",
"Size": 45613056,
"Type": 2,
"Target": ""
}]
]
}