文檔計(jì)劃 | IPFS API參考文檔

API 參考文檔

本文檔基于 go-ipfs v0.4.11-dev 版本，發(fā)布于2017年8月23日吞彤。

這是一篇關(guān)于 IPFS 的 HTTP API 說(shuō)明。

IPFS HTTP API 是一種 RPC API 接口叹放，在不同的IPFS實(shí)現(xiàn)之間都能工作饰恕。本說(shuō)明文檔所對(duì)應(yīng)的開(kāi)源庫(kù)實(shí)現(xiàn)為 go-ipfs，這也是目前功能最完備的實(shí)現(xiàn)井仰。

本文檔由 go-ipfs 自動(dòng)生成埋嵌。如有問(wèn)題或需要幫助，請(qǐng)查看 GitHub 上的 ipfs-http-api-docs 庫(kù)俱恶。

入門指南

符合 CLI 命令行界面

命令行界面（CLI）所有可用的命令行雹嗦，都可以使用HTTP API 來(lái)訪問(wèn)范舀。例如，

> ipfs swarm peers
/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
/ip4/104.236.151.122/tcp/4001/ipfs/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx
/ip4/104.236.176.52/tcp/4001/ipfs/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z

> curl http://127.0.0.1:5001/api/v0/swarm/peers
{
   "Strings": [

"/ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ",

"/ip4/104.236.151.122/tcp/4001/ipfs/QmSoLju6m7xTh3DuokvT3886QRYqxAzb1kShaanJgW36yx",

"/ip4/104.236.176.52/tcp/4001/ipfs/QmSoLnSGccFuZQJzRadHn95W2CrSFmZuTdDWP8HXaHca9z",
    ]
}

參數(shù)

使用關(guān)鍵字”arg“ 添加參數(shù)俐银，該關(guān)鍵字是一種特殊的查詢字符串尿背。

> curl "http://127.0.0.1:5001/api/v0/swarm/disconnect?arg=/ip4/54.93.113.247/
tcp/48131/ipfs/QmUDS3nsBD1X4XK5Jo836fed7SErTyTuQzRqWaiQAyBYMP"
{
    "Strings": [
        "disconnect QmUDS3nsBD1X4XK5Jo836fed7SErTyTuQzRqWaiQAyBYMP success",
    ]
}

注意：“arg”關(guān)鍵字可以多次使用來(lái)表示多個(gè)參數(shù)。

標(biāo)記

標(biāo)記通過(guò)查詢字符串參數(shù)添加捶惜。例如田藐，'--encoding = json' 標(biāo)志使用 '&encoding = json' 查詢參數(shù)表示:

> curl "http://127.0.0.1:5001/api/v0/object/get?arg=QmaaqrHyAQm7gALkRW8Dcf
GX3u8q9rWKnxEMmf7m9z515w&encoding=json"
{
    "Links": [
       {
           "Name": "index.html",
           "Hash": "QmYftndCvcEiuSZRX7njywX2AGSeHY2ASa7VryCq1mKwEw",
           "Size": 1700
       },
       {
           "Name": "static",
           "Hash": "QmdtWFiasJeh2ymW3TD2cLHYxn1ryTuWoNpwieFyJriGTS",
           "Size": 2428803
       }
    ],
    "Data": "CAE="
}

快速索引

/add
/bitswap/ledger
/bitswap/reprovide
/bitswap/stat
/bitswap/unwant
/bitswap/wantlist
/block/get
/block/put
/block/rm
/block/stat
/bootstrap/add/default
/bootstrap/list
/bootstrap/rm/all
/cat
/commands
/config/edit
/config/replace
/config/show
/dag/get
/dag/put
/dag/resolve
/dht/findpeer
/dht/findprovs
/dht/get
/dht/provide
/dht/put
/dht/query
/diag/cmds/clear
/diag/cmds/set-time
/diag/sys
/dns
/file/ls
/files/cp
/files/flush
/files/ls
/files/mkdir
/files/mv
/files/read
/files/rm
/files/stat
/files/write
/filestore/dups
/filestore/ls
/filestore/verify
/get
/id
/key/gen
/key/list
/key/rename
/key/rm
/log/level
/log/ls
/log/tail
/ls
/mount
/name/publish
/name/resolve
/object/data
/object/diff
/object/get
/object/links
/object/new
/object/patch/add-link
/object/patch/append-data
/object/patch/rm-link
/object/patch/set-data
/object/put
/object/stat
/p2p/listener/close
/p2p/listener/ls
/p2p/listener/open
/p2p/stream/close
/p2p/stream/dial
/p2p/stream/ls
/pin/add
/pin/ls
/pin/rm
/pin/update
/pin/verify
/ping
/pubsub/ls
/pubsub/peers
/pubsub/pub
/pubsub/sub
/refs/local
/repo/fsck
/repo/gc
/repo/stat
/repo/verify
/repo/version
/resolve
/shutdown
/stats/bitswap
/stats/bw
/stats/repo
/swarm/addrs/listen
/swarm/addrs/local
/swarm/connect
/swarm/disconnect
/swarm/filters/add
/swarm/filters/rm
/swarm/peers
/tar/add
/tar/cat
/update
/version

路徑列表

/api/v0/add

向 ipfs 添加文件或目錄。

參數(shù)

arg [file]: 待添加到 ipfs 的文件路徑吱七。是否必要: 是汽久。
recursive [bool]: 是否遞歸添加目錄路徑。默認(rèn): 否踊餐。是否必要: 否景醇。
quiet [bool]: 是否最小輸出。是否必要: 否吝岭。
quieter [bool]: 是否只寫(xiě)入哈希值三痰。是否必要: 否。
silent [bool]: 是否不輸出窜管。是否必要: 否散劫。
progress [bool]: Stream progress data. 是否必要: 否。
trickle [bool]: 是否使用 trickle-dag 格式算法生成DAG幕帆。是否必要: 否获搏。
only-hash [bool]: 是否僅僅出塊和hash，不寫(xiě)入磁盤失乾。是否必要: 否常熙。
wrap-with-directory [bool]: 是否使用目錄對(duì)象來(lái)包裝文件。是否必要: 否碱茁。
hidden [bool]: 是否添加隱藏文件裸卫，只有在遞歸的時(shí)候才有用。是否必要: 否纽竣。
chunker [string]: 使用的成塊算法彼城。是否必要: 否。
pin [bool]: 是否在添加的時(shí)候持久化 (不被垃圾回收所回收)退个。默認(rèn)：否募壕。是否必要: 否。
raw-leaves [bool]: 實(shí)驗(yàn)中的參數(shù)语盈。是否為葉子節(jié)點(diǎn)使用原始?jí)K舱馅。是否必要: 否。
nocopy [bool]: 實(shí)驗(yàn)中的參數(shù)刀荒。是否使用filestore存儲(chǔ)文件代嗤。是否必要: 否棘钞。
fscache [bool]: 實(shí)驗(yàn)中的參數(shù)。檢測(cè)filestore是否已經(jīng)存在了數(shù)據(jù)塊干毅。是否必要: 否宜猜。
cid-version [int]: 實(shí)驗(yàn)中的參數(shù)。返回 Cid 版本硝逢。非零值將把 ‘raw-leaves’ 的默認(rèn)值變?yōu)檎嬉逃怠ＤJ(rèn)：“0”。是否必要: 否渠鸽。
hash [string]: 實(shí)驗(yàn)中的參數(shù)叫乌。使用的哈希函數(shù)。使用時(shí)設(shè)置 Cid 值為1徽缚。默認(rèn): “sha2-256”憨奸。是否必要: 否。

請(qǐng)求體

參數(shù)“path”是一種文件類型凿试。這個(gè)路徑需要在請(qǐng)求主體（body）中有包含一個(gè) ‘multipart/form-data’ 文件排宰。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Name": "<string>"
    "Hash": "<string>"
    "Bytes": "<int64>"
    "Size": "<string>"
}

cURL 示例

curl -F file=@myfile 
"http://localhost:5001/api/v0/add?recursive=false&quiet=<value>&
quieter=<value>&silent=<value>&progress=<value>&trickle=<value>&
only-hash=<value>&wrap-with-directory=<value>&hidden=
<value>&chunker= <value>&pin=true&raw-leaves=<value>&nocopy=
<value>&fscache=<value>&cid-version=0&hash=sha2-256"

/api/v0/bitswap/ledger

顯示當(dāng)前節(jié)點(diǎn)的賬本信息那婉。

參數(shù)

arg [string]: 監(jiān)測(cè)賬本的節(jié)點(diǎn)ID额各。是否必要：是。

響應(yīng)

請(qǐng)求成功吧恃，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Peer": "<string>"
    "Value": "<float64>"
    "Sent": "<uint64>"
    "Recv": "<uint64>"
    "Exchanged": "<uint64>"
}

cURL 示例

curl "http://localhost:5001/api/v0/bitswap/ledger?arg=<peer>"

/api/v0/bitswap/reprovide

觸發(fā) reprovider。

參數(shù)

此接口不需要傳入?yún)?shù)麻诀。

響應(yīng)

請(qǐng)求成功痕寓，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/bitswap/reprovide"

/api/v0/bitswap/stat

展示bitswap代理的診斷信息。

參數(shù)

此接口不需要傳入?yún)?shù)蝇闭。

響應(yīng)

請(qǐng)求成功呻率，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ProvideBufLen": "<int>"
    "Wantlist": [
        "<string>"
    ]
    "Peers": [
        "<string>"
    ]
    "BlocksReceived": "<uint64>"
    "DataReceived": "<uint64>"
    "BlocksSent": "<uint64>"
    "DataSent": "<uint64>"
    "DupBlksReceived": "<uint64>"
    "DupDataReceived": "<uint64>"
}

cURL 示例

curl "http://localhost:5001/api/v0/bitswap/stat"

/api/v0/bitswap/unwant

從wantlist中移除給定區(qū)塊。

參數(shù)

arg [string]: 待移除的值呻引。是否必須：是礼仗。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/bitswap/unwant?arg=<key>"

/api/v0/bitswap/wantlist

顯示wantlist中的當(dāng)前塊列表逻悠。

參數(shù)

peer [string]: 需要展示wantlist的結(jié)點(diǎn)元践。是否必須：否。

響應(yīng)

請(qǐng)求成功童谒，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Keys": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/bitswap/wantlist?peer=<value>"

/api/v0/block/get

獲取原始IPFS塊单旁。

參數(shù)

arg [string]: 存在區(qū)塊的base58編碼的multihash。是否必須：是饥伊。

響應(yīng)

請(qǐng)求成功象浑，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/block/get?arg=<key>"

/api/v0/block/put

將輸入存儲(chǔ)為IPFS塊蔫饰。

參數(shù)

arg [file]: 需要被存儲(chǔ)為 IPFS 塊的數(shù)據(jù)。是否必須：是愉豺。
format [string]: 所創(chuàng)建塊的cid格式篓吁。默認(rèn): “v0”。是否必須：否蚪拦。
mhtype [string]: 返回multihash結(jié)構(gòu)的哈希函數(shù). 默認(rèn): “sha2-256”杖剪。是否必須：否。
mhlen [int]: multihash結(jié)構(gòu)的長(zhǎng)度外盯。默認(rèn): “-1”摘盆。是否必須：否。

請(qǐng)求體

參數(shù) “data” 是文件類型饱苟。此接口需要請(qǐng)求體‘multipart/form-data’中的文件孩擂。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Key": "<string>"
    "Size": "<int>"
}

cURL 示例

    curl -F file=@myfile "http://localhost:5001/api/v0/block/put?
    format=v0&mhtype=sha2-  256&mhlen=-1"

/api/v0/block/rm

移除IPFS塊箱熬。

參數(shù)

arg [string]: 將被移除的base58編碼的multihash區(qū)塊类垦。是否必須：是。
force [bool]: 是否忽略不存在的區(qū)塊城须。默認(rèn)：否蚤认。是否必須：否。
quiet [bool]: 是否最小輸出糕伐。默認(rèn): 否砰琢。是否必須：否。

響應(yīng)

請(qǐng)求成功良瞧，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Error": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/block/rm?arg=<hash>&force=false&quiet=false"

/api/v0/block/stat

打印原始IPFS塊的信息陪汽。

參數(shù)

arg [string]: 當(dāng)前塊的base58 multihash。是否必須：是褥蚯。

響應(yīng)

請(qǐng)求成功挚冤，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Key": "<string>"
    "Size": "<int>"
}

cURL 示例

curl "http://localhost:5001/api/v0/block/stat?arg=<key>"

/api/v0/bootstrap/add/default

向bootstrap列表中添加默認(rèn)peer。

參數(shù)

此接口不需要傳入?yún)?shù)赞庶。

響應(yīng)

請(qǐng)求成功训挡，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Peers": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/bootstrap/add/default"

/api/v0/bootstrap/list

顯示bootstrap列表中的peers。

參數(shù)

此接口不需要傳入?yún)?shù)歧强。

響應(yīng)

請(qǐng)求成功澜薄，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Peers": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/bootstrap/list"

/api/v0/bootstrap/rm/all

移除bootstrap列表中的所有peers。

參數(shù)

此接口不需要傳入?yún)?shù)摊册。

響應(yīng)

請(qǐng)求成功表悬，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Peers": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/bootstrap/rm/all"

/api/v0/cat

顯示IPFS的對(duì)象數(shù)據(jù)。

參數(shù)A

arg [string]: The path to the IPFS object(s) to be outputted. Required: yes.

響應(yīng)

請(qǐng)求成功丧靡，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/cat?arg=<ipfs-path>"

/api/v0/commands

顯示所有有效指令蟆沫。

參數(shù)

flags [bool]: 是否顯示命令標(biāo)記籽暇。默認(rèn): 否。是否必須：否饭庞。

響應(yīng)

請(qǐng)求成功戒悠，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Name": "<string>"
    "Subcommands": [
        {
            "Name": "<string>"
            "Subcommands": [
                {
                    "Name": "<string>"
                    "Subcommands": [
                        ...
                    ]
                    "Options": [
                        ...
                    ]
                }
            ]
            "Options": [
                {
                    "Names": [
                        ...
                    ]
                }
             ]
        }
    ]
    "Options": [
        {
            "Names": [
                "<string>"
            ]
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/commands?flags=false"

/api/v0/config/edit

在$EDITOR中打開(kāi)配置文件進(jìn)行編輯。

參數(shù)

此接口不需要傳入?yún)?shù)舟山。

響應(yīng)

請(qǐng)求成功绸狐，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/config/edit"

/api/v0/config/replace

替換配置文件。

參數(shù)

arg [file]: 用作新配置文件的文件累盗。是否必須：是寒矿。

請(qǐng)求體

參數(shù)"file"是文件類型。此接口需要請(qǐng)求體 ‘multipart/form-data’ 中的文件若债。

響應(yīng)

請(qǐng)求成功符相，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl -F file=@myfile "http://localhost:5001/api/v0/config/replace"

/api/v0/config/show

輸出配置文件內(nèi)容。

參數(shù)

此接口不需要傳入?yún)?shù)蠢琳。

響應(yīng)

請(qǐng)求成功啊终，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

 This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/config/show"

/api/v0/dag/get

獲取ipfs中的一個(gè)dag節(jié)點(diǎn)。

參數(shù)

arg [string]: 要獲取的對(duì)象節(jié)點(diǎn)傲须。是否必須：是蓝牲。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/dag/get?arg=<ref>"

/api/v0/dag/put

向ipfs中添加一個(gè)dag節(jié)點(diǎn)泰讽。

參數(shù)

arg [file]: 要放入的節(jié)點(diǎn)對(duì)象例衍。是否必須：是。
format [string]: 將需要添加的對(duì)象轉(zhuǎn)化為指定格式已卸。默認(rèn): “cbor”佛玄。是否必須：否。
input-enc [string]: 將輸入對(duì)象轉(zhuǎn)化為指定格式咬最。默認(rèn): “json”。是否必須：否欠动。
pin [bool]: 是否在添加的時(shí)候持久化永乌。默認(rèn): 否。是否必須：否具伍。
hash [string]: 使用的哈希函數(shù)翅雏。默認(rèn): “sha2-256”。是否必要: 否人芽。

請(qǐng)求體

參數(shù)'object data'是文件類型望几。此接口需要請(qǐng)求體‘multipart/form-data’中的文件。

響應(yīng)

請(qǐng)求成功萤厅，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Cid": "<string>"
}

cURL 示例

curl -F file=@myfile "http://localhost:5001/api/v0/dag/put?
format=cbor&input-enc=json&pin=false&hash=<value>"

/api/v0/dag/resolve

解析ipId塊橄抹。

參數(shù)

arg [string]: 需要解析的路徑靴迫。是否必須: 是。

響應(yīng)

請(qǐng)求成功楼誓，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Cid": "<string>"
    "RemPath": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dag/resolve?arg=<ref>"

/api/v0/dht/findpeer

查詢和節(jié)點(diǎn)ID相關(guān)聯(lián)的多地址的所有DHT信息玉锌。

參數(shù)

arg [string]: 需要查詢的節(jié)點(diǎn)ID。是否必須: 是疟羹。
verbose [bool]: 是否輸出其他信息主守。默認(rèn): 否。是否必須: 否榄融。

響應(yīng)

請(qǐng)求成功参淫，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/findpeer?arg=<peerID>&verbose=false"

/api/v0/dht/findprovs

在DHT網(wǎng)絡(luò)中找到有指定值的節(jié)點(diǎn)。

參數(shù)

arg [string]: 有指定值的節(jié)點(diǎn)的鍵愧杯。是否必須: 是涎才。
verbose [bool]: 是否輸出其他信息。默認(rèn): 否民效。是否必須: 否憔维。
num-providers [int]: 有指定值的節(jié)點(diǎn)數(shù)量。默認(rèn): 20畏邢。是否必須: 否业扒。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/findprovs?arg=<key>&
verbose=false&num-providers=20"

/api/v0/dht/get

給定一個(gè)鍵舒萎，在DHT表中查詢最佳值程储。

參數(shù)

arg [string]: 需要查詢值的鍵。是否必須: 是臂寝。
verbose [bool]: 是否輸出其他信息章鲤。默認(rèn): 否。是否必須: 否咆贬。

響應(yīng)

請(qǐng)求成功败徊，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/get?arg=<key>&verbose=false"

/api/v0/dht/provide

向網(wǎng)絡(luò)宣布正在提供給定的值。

參數(shù)

arg [string]: 需要接受記錄的所有節(jié)點(diǎn)的鍵掏缎。是否必須: 是皱蹦。
verbose [bool]: 是否輸出其他信息。默認(rèn): 否眷蜈。是否必須: 否沪哺。
recursive [bool]: 是否遞歸添加目錄路徑酌儒。是否輸出其他信息辜妓。默認(rèn): 否。是否必須: 否。

響應(yīng)

請(qǐng)求成功籍滴，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                 "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/provide?arg=<key>&verbose=false&recursive=false"

/api/v0/dht/put

往DHT網(wǎng)絡(luò)中寫(xiě)入key-value值酪夷。

參數(shù)

arg [string]: 存取特定值的節(jié)點(diǎn)的鍵。是否必須: 是异逐。
arg [string]: 要存儲(chǔ)的值捶索。是否必須: 是。
verbose [bool]: 是否輸出其他信息灰瞻。默認(rèn): 否腥例。是否必須: 否。

響應(yīng)

請(qǐng)求成功酝润，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/put?arg=<key>&arg=<value>&verbose=false"

/api/v0/dht/query

通過(guò)查詢DHT網(wǎng)絡(luò)找到與給定節(jié)點(diǎn)最近的節(jié)點(diǎn)燎竖。

參數(shù)

arg [string]: 針對(duì)此次查詢的節(jié)點(diǎn) ID。是否必須: 是要销。
verbose [bool]: 是否輸出其他信息构回。默認(rèn): 否。是否必須: 否疏咐。

響應(yīng)

請(qǐng)求成功纤掸，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "Type": "<int>"
    "Responses": [
        {
            "ID": "<string>"
            "Addrs": [
                "<object>"
            ]
        }
    ]
    "Extra": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dht/query?arg=<peerID>&verbose=false"

/api/v0/diag/cmds/clear

從日志中清除失效請(qǐng)求。

參數(shù)

此接口不需要傳入?yún)?shù)浑塞。

響應(yīng)

請(qǐng)求成功借跪，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/diag/cmds/clear"

/api/v0/diag/cmds/set-time

設(shè)置在日志中保存失效請(qǐng)求的時(shí)間。

參數(shù)

arg [string]: 在日志中保存失效請(qǐng)求的時(shí)間酌壕。是否必須: 是掏愁。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

 This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/diag/cmds/set-time?arg=<time>"

/api/v0/diag/sys

打印系統(tǒng)診斷信息卵牍。

參數(shù)

此接口不需要傳入?yún)?shù)果港。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/diag/sys"

/api/v0/dns

解析DNS鏈接糊昙。

參數(shù)

arg [string]: 需要解析的域名辛掠。是否必須: 是。
recursive [bool]: 是否遞進(jìn)解析释牺，終止條件為解析結(jié)果不是 DNS 鏈接萝衩。默認(rèn): 否。是否必須: 否船侧。

響應(yīng)

請(qǐng)求成功欠气，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Path": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/dns?arg=<domain-name>&recursive=false"

/api/v0/file/ls

列出Unix文件系統(tǒng)對(duì)象的目錄內(nèi)容厅各。

參數(shù)

arg [string]: 所列出 ipfs 對(duì)象的路徑镜撩。是否必須: 是。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Arguments": {
        "<string>": "<string>"
    }
    "Objects": {
        "<string>": {
            "Hash": "<string>"
            "Size": "<uint64>"
            "Type": "<string>"
            "Links": [
                {
                    "Name": "<string>"
                    "Hash": "<string>"
                    "Size": "<uint64>"
                    "Type": "<string>"
                }
            ]
        }
    }
}

cURL 示例

curl "http://localhost:5001/api/v0/file/ls?arg=<ipfs-path>"

/api/v0/files/cp

復(fù)制文件到mfs袁梗。

參數(shù)

arg [string]: 要復(fù)制的源對(duì)象宜鸯。是否必須: 是。
arg [string]: 復(fù)制的目的地遮怜。是否必須: 是淋袖。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/cp?arg=<source>&arg=<dest>"

/api/v0/files/flush

將給定路徑的數(shù)據(jù)刷新到磁盤锯梁。

參數(shù)

arg [string]: 落盤路徑即碗。默認(rèn): ‘/’。是否必須: 否陌凳。

響應(yīng)

請(qǐng)求成功剥懒，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/flush?arg=<path>"

/api/v0/files/ls

列出本地可變命名空間中的目錄。

參數(shù)

arg [string]: 顯示列表的路徑合敦。默認(rèn): ‘/’初橘。是否必須: 否。
l [bool]: 是否使用長(zhǎng)列表格式充岛。是否必須: 否保檐。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Entries": [
        {
            "Name": "<string>"
            "Type": "<int>"
            "Size": "<int64>"
            "Hash": "<string>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/files/ls?arg=<path>&l=<value>"

/api/v0/files/mkdir

創(chuàng)建目錄。

參數(shù)

arg [string]: 創(chuàng)建目錄的路徑。是否必須: 是姥宝。
parents [bool]: 如果存在父目錄廊酣，是否顯示 No error；否則帚屉，是否創(chuàng)建父目錄。是否必須: 否。

響應(yīng)

請(qǐng)求成功砸王，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/mkdir?arg=<path>&parents=<value>"

/api/v0/files/mv

移動(dòng)文件。

參數(shù)

arg [string]: 需要移動(dòng)的源文件峦阁。是否必須: 是谦铃。
arg [string]: 文件拷貝到的目標(biāo)路徑。是否必須: 是榔昔。

響應(yīng)

請(qǐng)求成功驹闰，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/mv?arg=<source>&arg=<dest>"

/api/v0/files/read

讀取給定mfs中的文件。

參數(shù)

arg [string]: 需要讀取的文件的路徑撒会。是否必須: 是嘹朗。
offset [int]: 讀取處的字節(jié)偏移量。是否必須: 否诵肛。
count [int]: 讀取的字節(jié)數(shù)量最大值屹培。是否必須: 否。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/read?arg=<path>&offset=<value>&count=<value>"

/api/v0/files/rm

移除文件褪秀。

參數(shù)

arg [string]: 需要移除的文件蓄诽。是否必須: 是。
recursive [bool]: 是否遞歸地移除目錄媒吗。是否必須: 否仑氛。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/files/rm?arg=<path>&recursive=<value>"

/api/v0/files/stat

顯示文件狀態(tài)闸英。

參數(shù)

arg [string]: 需要顯示狀態(tài)的節(jié)點(diǎn)的路徑锯岖。是否必須: 是。
format [string]: 以給定格式輸出文件狀態(tài)甫何。支持的符號(hào): .嚎莉。不支持其他格式。默認(rèn): Size: CumulativeSize: ChildBlocks: Type: 沛豌。默認(rèn): “ Size: CumulativeSize: ChildBlocks: Type: ”趋箩。是否必須: 否。
hash [bool]: 是否只輸出哈希值加派。指示 ‘–format=’叫确。不支持其他格式。默認(rèn): 否芍锦。是否必須: 否竹勉。
size [bool]: 是否只輸出大小。指示 ‘–format=’娄琉。不支持其他格式次乓。默認(rèn): 否。是否必須: 否孽水。

響應(yīng)

請(qǐng)求成功票腰，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Size": "<uint64>"
    "CumulativeSize": "<uint64>"
    "Blocks": "<int>"
    "Type": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/files/stat?arg=<path>&format=<hash> 
Size: <size>  CumulativeSize:  <cumulsize> ChildBlocks: <childs> 
Type: <type>&hash=false&size=false"

/api/v0/files/write

寫(xiě)入給定文件系統(tǒng)中的可變文件。

參數(shù)

arg [string]: 寫(xiě)入路徑女气。是否必須: 是杏慰。
arg [file]: 需要寫(xiě)入的數(shù)據(jù)。是否必須: 是炼鞠。
offset [int]: 開(kāi)始寫(xiě)入處的字節(jié)偏移量缘滥。是否必須: 否。
create [bool]: 如果文件不存在谒主，是否創(chuàng)建文件朝扼。是否必須: 否。
truncate [bool]: 寫(xiě)入之前是否把文件長(zhǎng)度截?cái)酁榱泠稀Ｊ欠癖仨? 否擎颖。
count [int]: 讀取字節(jié)的長(zhǎng)度最大值凹耙。是否必須: 否。

請(qǐng)求體

參數(shù)'data'是文件類型肠仪。此接口需要請(qǐng)求體‘multipart/form-data’中的文件。

響應(yīng)

請(qǐng)求成功备典，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl -F file=@myfile "http://localhost:5001/api/v0/files/write?arg=<path>&
offset=<value>&create=<value>&truncate=<value>&count=<value>"

/api/v0/filestore/dups

列出filestore和標(biāo)準(zhǔn)塊存儲(chǔ)中的塊异旧。

參數(shù)

此接口不需要傳入?yún)?shù)。

響應(yīng)

請(qǐng)求成功提佣，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Ref": "<string>"
    "Err": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/filestore/dups"

/api/v0/filestore/ls

列出filestore中的對(duì)象列表吮蛹。

參數(shù)

arg [string]: 需要列出的對(duì)象的Cid。是否必須: 否拌屏。
file-order [bool]: 是否根據(jù)備份文件的路徑順序?qū)Y(jié)果進(jìn)行排序潮针。是否必須: 否。

響應(yīng)

請(qǐng)求成功倚喂，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Status": "<int32>"
    "ErrorMsg": "<string>"
    "Key": "<string>"
    "FilePath": "<string>"
    "Offset": "<uint64>"
    "Size": "<uint64>"
}

cURL 示例

curl "http://localhost:5001/api/v0/filestore/ls?arg=<obj>&file-order=<value>"

/api/v0/filestore/verify

驗(yàn)證filestore中的對(duì)象每篷。

參數(shù)

arg [string]: 待驗(yàn)證的對(duì)象的Cid。是否必須: 否端圈。
file-order [bool]: 是否根據(jù)備份文件的路徑順序?qū)Y(jié)果進(jìn)行驗(yàn)證焦读。是否必須: 否。

響應(yīng)

請(qǐng)求成功舱权，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Status": "<int32>"
    "ErrorMsg": "<string>"
    "Key": "<string>"
    "FilePath": "<string>"
    "Offset": "<uint64>"
    "Size": "<uint64>"

}

cURL 示例

 curl "http://localhost:5001/api/v0/filestore/verify?arg=<obj>&file-order=<value>"

/api/v0/get

下載IPFS對(duì)象矗晃。

參數(shù)

arg [string]: 接收輸出結(jié)果的IPFS 對(duì)象的路徑。是否必須: 是宴倍。
output [string]: 存儲(chǔ)輸出結(jié)果的路徑张症。是否必須: 否。
archive [bool]: 是否輸出一個(gè) TAR 壓縮包鸵贬。默認(rèn): 否俗他。是否必須: 否。
compress [bool]: 是否使用 GZIP 壓縮法對(duì)輸出進(jìn)行壓縮阔逼。默認(rèn): 否拯辙。是否必須: 否。
compression-level [int]: 壓縮等級(jí) (1-9). 默認(rèn): “-1”颜价。是否必須: 否涯保。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/get?arg=<ipfs-path>&output= <value>&archive=false&compress=false&compression-level=-1"

/api/v0/id

顯示ipfs節(jié)點(diǎn)id周伦。

參數(shù)

arg [string]: 需要查詢的節(jié)點(diǎn)的 ID夕春。是否必須: 否。
format [string]: 備選的輸出格式专挪。是否必須: 否及志。

響應(yīng)

請(qǐng)求成功片排，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ID": "<string>"
    "PublicKey": "<string>"
    "Addresses": [
        "<string>"
    ]
    "AgentVersion": "<string>"
    "ProtocolVersion": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/id?arg=<peerid>&format=<value>"

/api/v0/key/gen

創(chuàng)建一個(gè)新的鍵值對(duì)。

參數(shù)

arg [string]: 新建鍵的名字速侈。是否必須: 是率寡。
type [string]: 新建鍵的類型 [rsa, ed25519]。是否必須: 否倚搬。
size [int]: 新建鍵的長(zhǎng)度冶共。是否必須: 否。

響應(yīng)

請(qǐng)求成功每界，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Name": "<string>"
    "Id": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/key/gen?arg=<name>&type=<value>&size=<value>"

/api/v0/key/list

顯示本地所有鍵值對(duì)捅僵。

參數(shù)

l [bool]: 是否顯示鍵的其他信息。是否必須: 否眨层。

響應(yīng)

請(qǐng)求成功庙楚，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Keys": [
        {
            "Name": "<string>"
            "Id": "<string>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/key/list?l=<value>"

/api/v0/key/rename

重命名一個(gè)鍵值對(duì)。

參數(shù)

arg [string]: 需要重命名的鍵現(xiàn)在的名字趴樱。是否必須: 是馒闷。
arg [string]: 鍵的新名字。是否必須: 是叁征。
force [bool]: 是否允許覆蓋存在的鍵窜司。是否必須: 否。

響應(yīng)

請(qǐng)求成功航揉，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Was": "<string>"
    "Now": "<string>"
    "Id": "<string>"
    "Overwrite": "<bool>"
}

cURL 示例

curl "http://localhost:5001/api/v0/key/rename?arg=<name>&arg=<newName>&force=<value>"

/api/v0/key/rm

移除一個(gè)鍵值對(duì)塞祈。

參數(shù)

arg [string]: 待移除的鍵的名字。是否必須: 是帅涂。
l [bool]: 是否顯示鍵的其他信息议薪。是否必須: 否。

響應(yīng)

請(qǐng)求成功媳友，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Keys": [
        {
            "Name": "<string>"
            "Id": "<string>"
        }
    ]
}

cURL 示例

 curl "http://localhost:5001/api/v0/key/rm?arg=<name>&l=<value>"

/api/v0/log/level

修改日志級(jí)別斯议。

參數(shù)

arg [string]: 子系統(tǒng)登日志識(shí)別符。所有子系統(tǒng)都使用 ‘a(chǎn)ll’醇锚。是否必須: 是哼御。
arg [string]: 日志級(jí)別, 從 debug, info, warning, error 到 critical，其中最冗長(zhǎng)的日志標(biāo)記為 ‘debug'焊唬，最短的日志標(biāo)記為 ‘critical’恋昼。是否必須: 是。

響應(yīng)

請(qǐng)求成功赶促，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Message": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/log/level?arg=<subsystem>&arg=<level>"

/api/v0/log/ls

列出日志子系統(tǒng)液肌。

參數(shù)

此接口不需要傳入?yún)?shù)。

響應(yīng)

請(qǐng)求成功鸥滨，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/log/ls"

/api/v0/log/tail

讀取事件日志嗦哆。

參數(shù)

此接口不需要傳入?yún)?shù)谤祖。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/log/tail"

/api/v0/ls

列出Unix文件系統(tǒng)對(duì)象的目錄內(nèi)容老速。

參數(shù)

arg [string]: 鏈接到列表的 IPFS 對(duì)象的路徑粥喜。是否必須: 是。
headers [bool]: 是否輸出表頭 (Hash, Size, Name)橘券。默認(rèn): 否额湘。是否必須: 否。
resolve-type [bool]: 是否解析鏈接的對(duì)象來(lái)檢測(cè)其數(shù)據(jù)類型约郁。默認(rèn): 是。是否必須: 否但两。

響應(yīng)

請(qǐng)求成功鬓梅，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Objects": [
        {
            "Hash": "<string>"
            "Links": [
                {
                    "Name": "<string>"
                    "Hash": "<string>"
                    "Size": "<uint64>"
                    "Type": "<int32>"
                }
            ]
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/ls?arg=<ipfs-path>&headers=false&resolve-type=true"

/api/v0/mount

將IPFS掛載到文件系統(tǒng)(只讀)。

參數(shù)

ipfs-path [string]: IPFS 掛載路徑谨湘。是否必須: 否绽快。
ipns-path [string]: IPNS 掛載路徑。是否必須: 否紧阔。

響應(yīng)

請(qǐng)求成功坊罢，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "IPFS": "<string>"
    "IPNS": "<string>"
    "FuseAllowOther": "<bool>"
}

cURL 示例

curl "http://localhost:5001/api/v0/mount?ipfs-path=<value>&ipns-path=<value>"

/api/v0/name/publish

輸出IPNS名錄。

參數(shù)

arg [string]: 待輸出對(duì)象的 ipfs 訪問(wèn)路徑擅耽。是否必須: 是活孩。
resolve [bool]: 輸出前是否解析給定路徑。默認(rèn): 是乖仇。是否必須: 否憾儒。
lifetime [string]: 記錄合理化的時(shí)間長(zhǎng)度∧松常可接受的長(zhǎng)度有 “300s”, “1.5h” 或 “2h45m”起趾。有效的時(shí)間單位是 “ns”, “us” (or “μs”), “ms”, “s”, “m”, “h”。默認(rèn): “24h”警儒。是否必須: 否训裆。
ttl [string]: 記錄的緩存時(shí)間長(zhǎng)度。請(qǐng)注意蜀铲，這是實(shí)驗(yàn)參數(shù)边琉。是否必須: 否。
key [string]: ‘ipfs key list -l’ 中所列的待使用鍵或者有效節(jié)點(diǎn) ID 的名字记劝。默認(rèn): “self”艺骂。是否必須: 否。

響應(yīng)

請(qǐng)求成功隆夯，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Name": "<string>"
    "Value": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/name/publish?arg=<ipfs-path>&
resolve=true&lifetime=24h&ttl=<value>&key=self"

/api/v0/name/resolve

解析IPNS名字钳恕。

參數(shù)

arg [string]: 待解析的 IPNS 名别伏。默認(rèn): 你的節(jié)點(diǎn) ID。是否必須: 否忧额。
recursive [bool]: 當(dāng)結(jié)果是 IPNS 名時(shí)是否遞歸解析厘肮。默認(rèn): 否。是否必須: 否睦番。
nocache [bool]: 是否棄用緩存條目类茂。默認(rèn): 否。是否必須: 否托嚣。

響應(yīng)

請(qǐng)求成功巩检，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Path": "<string>"
}

cURL 示例

curl 
"http://localhost:5001/api/v0/name/resolve?arg=<name>&recursive=false&nocache=false"

/api/v0/object/data

輸出IPFS對(duì)象的原始字節(jié)。

參數(shù)

arg [string]: 待檢索對(duì)象的鍵示启，格式是 base58 編碼的multihash兢哭。是否必須: 是。

響應(yīng)

請(qǐng)求成功夫嗓，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

 curl "http://localhost:5001/api/v0/object/data?arg=<key>"

/api/v0/object/diff

顯示兩個(gè)ipfs對(duì)象之間的差異迟螺。

參數(shù)

arg [string]: 被比較的對(duì)象。是否必須: 是舍咖。
arg [string]: 待比較的對(duì)象矩父。是否必須: 是。
verbose [bool]: 是否輸出其他信息排霉。是否必須: 否窍株。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Changes": [
        {
            "Type": "<int>"
            "Path": "<string>"
            "Before": "<string>"
            "After": "<string>"
        }
    ]
}

cURL 示例

curl 
"http://localhost:5001/api/v0/object/diff?arg=<obj_a>&arg=<obj_b>&verbose=<value>"

/api/v0/object/get

獲取并序列化DAG節(jié)點(diǎn)攻柠。

參數(shù)

arg [string]: 待檢索對(duì)象的鍵夹姥，格式是 base58 編碼的multihash。是否必須: 是辙诞。

響應(yīng)

請(qǐng)求成功辙售，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
    "Data": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/object/get?arg=<key>"

/api/v0/object/links

輸出指定對(duì)象指向的鏈接。

參數(shù)

arg [string]: 待檢索對(duì)象的鍵飞涂，格式是 base58 編碼的multihash旦部。是否必須: 是。
headers [bool]: 打印表頭 (Hash, Size, Name)较店。默認(rèn): 否士八。是否必須: 否。

響應(yīng)

請(qǐng)求成功梁呈，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/object/links?arg=<key>&headers=false"

/api/v0/object/new

從ipfs模板創(chuàng)建一個(gè)新對(duì)象婚度。

參數(shù)

arg [string]: 待用模版」倏ǎ可選蝗茁。是否必須: 否醋虏。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/object/new?arg=<template>"

/api/v0/object/patch/add-link

向給定對(duì)象添加鏈接哮翘。

參數(shù)

arg [string]: 待調(diào)整節(jié)點(diǎn)的哈希值颈嚼。是否必須: 是。
arg [string]: 新建連接的名字饭寺。是否必須: 是阻课。
arg [string]: 需要添加連接的 IPFS 對(duì)象。是否必須: 是艰匙。
create [bool]: 是否創(chuàng)建中間節(jié)點(diǎn)限煞。默認(rèn): 否。是否必須: 否员凝。

響應(yīng)

請(qǐng)求成功署驻，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl 
"http://localhost:5001/api/v0/object/patch/add-link?arg=
<root>&arg=<name>&arg=<ref>&create=false"

/api/v0/object/patch/append-data

將數(shù)據(jù)追加到dag節(jié)點(diǎn)的數(shù)據(jù)段。

參數(shù)

arg [string]: 待調(diào)整節(jié)點(diǎn)的哈希值绊序。是否必須: 是硕舆。
arg [file]: 待追加數(shù)據(jù)秽荞。是否必須: 是骤公。

請(qǐng)求體

參數(shù)‘data’是文件類型。該接口需要請(qǐng)求體'multipart/form-data'的文件扬跋。

響應(yīng)

請(qǐng)求成功阶捆，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
"Hash": "<string>"
"Links": [
{
"Name": "<string>"
"Hash": "<string>"
"Size": "<uint64>"
}
]
}

cURL 示例

curl -F file=
@myfile "http://localhost:5001/api/v0/object/patch/append-data?arg=<root>"

/api/v0/object/patch/rm-link

從對(duì)象中刪除鏈接。

參數(shù)

arg [string]: 待調(diào)整節(jié)點(diǎn)的哈希值钦听。是否必須: 是洒试。
arg [string]: 待移除連接的名字。是否必須: 是朴上。

響應(yīng)

請(qǐng)求成功垒棋，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl 
"http://localhost:5001/api/v0/object/patch/rm-link?arg=<root>&arg=<link>"

/api/v0/object/patch/set-data

設(shè)置IPFS對(duì)象的數(shù)據(jù)字段。

參數(shù)

arg [string]: 待調(diào)整節(jié)點(diǎn)的哈希值痪宰。是否必須: 是叼架。
arg [file]: 待設(shè)置對(duì)象的數(shù)據(jù)字段。是否必須: 是衣撬。

請(qǐng)求體

參數(shù)‘data’是文件類型乖订。該接口需要請(qǐng)求體'multipart/form-data'的文件。

響應(yīng)

請(qǐng)求成功具练，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl -F file=
@myfile "http://localhost:5001/api/v0/object/patch/set-data?arg=<root>"

/api/v0/object/put

將輸入存儲(chǔ)為DAG對(duì)象乍构，打印其鍵。

參數(shù)

arg [file]: 需要被存儲(chǔ)為 DAG 對(duì)象的數(shù)據(jù)扛点。是否必須: 是哥遮。
inputenc [string]: 輸入數(shù)據(jù)的編碼類型岂丘，包括 “protobuf”和 “json”。默認(rèn): “json”昔善。是否必須: 否元潘。
datafieldenc [string]: 數(shù)據(jù)域的編碼類型，包括 “text” 和 “base64”君仆。默認(rèn): “text”翩概。是否必須: 否。
pin [bool]: 在添加對(duì)象時(shí)是否對(duì)其進(jìn)行本地持久化存儲(chǔ)返咱。默認(rèn): 否钥庇。是否必須: 否。

請(qǐng)求體

參數(shù) 'data' 是文件類型咖摹。該接口需要請(qǐng)求體 ‘multipart/form-data’ 的文件评姨。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "Links": [
        {
            "Name": "<string>"
            "Hash": "<string>"
            "Size": "<uint64>"
        }
    ]
}

cURL 示例

curl -F file=@myfile "http://localhost:5001/api/v0/object/
put?inputenc=json&datafieldenc=text&pin=false"

/api/v0/object/stat

獲取DAG節(jié)點(diǎn)的信息萤晴。

參數(shù)

arg [string]: 檢索對(duì)象的鍵吐句，格式是 base58 編碼的 multihash。是否必須: 是店读。

響應(yīng)

請(qǐng)求成功嗦枢，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Hash": "<string>"
    "NumLinks": "<int>"
    "BlockSize": "<int>"
    "LinksSize": "<int>"
    "DataSize": "<int>"
    "CumulativeSize": "<int>"
}

cURL 示例

 curl "http://localhost:5001/api/v0/object/stat?arg=<key>"

/api/v0/p2p/listener/close

關(guān)閉p2p listener。

參數(shù)

arg [string]: P2P 監(jiān)聽(tīng)協(xié)議屯断。是否必須: 否文虏。 Required: no.
all [bool]: 是否關(guān)閉所有監(jiān)聽(tīng)。默認(rèn): 否殖演。是否必須: 否氧秘。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/p2p/listener/close?arg=<Protocol>&all=false"

/api/v0/p2p/listener/ls

列舉活躍的p2p 監(jiān)聽(tīng)趴久。

參數(shù)

headers [bool]: 打印表頭 (HandlerID, Protocol, Local, Remote)丸相。默認(rèn): 否。是否必須: 否彼棍。

響應(yīng)

請(qǐng)求成功灭忠，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Listeners": [
        {
            "Protocol": "<string>"
            "Address": "<string>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/p2p/listener/ls?headers=false"

/api/v0/p2p/listener/open

將p2p連接轉(zhuǎn)發(fā)到網(wǎng)絡(luò)多地址。

參數(shù)

arg [string]: 協(xié)議標(biāo)示符滥酥。是否必須: 是更舞。
arg [string]: 請(qǐng)求處理的程序地址。是否必須: 是坎吻。

響應(yīng)

請(qǐng)求成功缆蝉，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl 
"http://localhost:5001/api/v0/p2p/listener/open?arg=<Protocol>&arg=<Address>"

/api/v0/p2p/stream/close

關(guān)閉活躍的p2p流。

參數(shù)

arg [string]: 流的 HandlerID。是否必須: 否刊头。
all [bool]: 是否關(guān)閉所有流黍瞧。默認(rèn): 否。是否必須: 否原杂。

響應(yīng)

請(qǐng)求成功印颤，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/p2p/stream/close?arg=<HandlerID>&all=false"

/api/v0/p2p/stream/dial

撥號(hào)到p2p Listener。

參數(shù)

arg [string]: 需要連接的遠(yuǎn)端節(jié)點(diǎn)穿肄。是否必須: 是年局。
arg [string]: 協(xié)議標(biāo)示符。是否必須: 是咸产。
arg [string]: 連接監(jiān)聽(tīng)地址朴艰。默認(rèn): /ip4/127.0.0.1/tcp/0)琼掠。是否必須: 否马胧。

響應(yīng)

請(qǐng)求成功席纽，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl 
"http://localhost:5001/api/v0/p2p/stream/dial?arg=<Peer>&arg=<Protocol>&arg=<BindAddress>"

/api/v0/p2p/stream/ls

列出活躍的p2p流。

參數(shù)

headers [bool]: 打印表頭 (HagndlerID, Protocol, Local, Remote)屑彻。默認(rèn): 否验庙。是否必須: 否。

響應(yīng)

請(qǐng)求成功社牲，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Streams": [
        {
            "HandlerID": "<string>"
            "Protocol": "<string>"
            "LocalPeer": "<string>"
            "LocalAddress": "<string>"
            "RemotePeer": "<string>"
            "RemoteAddress": "<string>"
        }
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/p2p/stream/ls?headers=false"

/api/v0/pin/add

將對(duì)象固定到本地存儲(chǔ)粪薛。

參數(shù)

arg [string]: 發(fā)送回顯信息的對(duì)象的訪問(wèn)路徑。是否必須: 是膳沽。
recursive [bool]: 是否遞歸地本地持久化與指定對(duì)象連接的對(duì)象汗菜。默認(rèn): 是让禀。是否必須: 否挑社。
progress [bool]: 是否打印進(jìn)程。是否必須: 否巡揍。

響應(yīng)

請(qǐng)求成功痛阻，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Pins": [
        "<string>"
    ]
    "Progress": "<int>"
}

cURL 示例

curl "http://localhost:5001/api/v0/pin/add?arg=<ipfs-path>&
recursive=true&progress=<value>"

/api/v0/pin/ls

列出固定到本地存儲(chǔ)的對(duì)象。

參數(shù)

arg [string]: 待列出的對(duì)象的訪問(wèn)路徑腮敌。是否必須: 否阱当。
type [string]: 待列出的本地持久化鍵的類型，包括 “direct”, “indirect”, “recursive”, 和 “all”糜工。默認(rèn): “all”弊添。是否必須: 否。
quiet [bool]: 是否僅輸出對(duì)象的哈希值捌木。默認(rèn): 否油坝。是否必須: 否。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Keys": {
        "<string>": {
            "Type": "<string>"
        }
    }
}

cURL 示例

curl "http://localhost:5001/api/v0/pin/ls?arg=<ipfs-path>&type=all&quiet=false"

/api/v0/pin/rm

從本地存儲(chǔ)中刪除固定對(duì)象澈圈。

參數(shù)

arg [string]: 要?jiǎng)h除的對(duì)象的訪問(wèn)路徑彬檀。是否必須: 是。
recursive [bool]: 是否遞歸刪除與固定對(duì)象相連的對(duì)象瞬女。默認(rèn): 是窍帝。是否必須: 否。

響應(yīng)

請(qǐng)求成功诽偷，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Pins": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/pin/rm?arg=<ipfs-path>&recursive=true"

/api/v0/pin/update

更新一個(gè)recursive pin坤学。

參數(shù)

arg [string]: 舊對(duì)象路徑。是否必須: 是报慕。
arg [string]: 需要本地持久化的對(duì)象的訪問(wèn)路徑拥峦。是否必須: 是。
unpin [bool]: 刪除舊的本地持久化對(duì)象卖子。默認(rèn): 是略号。是否必須: 否。

響應(yīng)

請(qǐng)求成功洋闽，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Pins": [
        "<string>"
    ]
}

cURL 示例

curl 
"http://localhost:5001/api/v0/pin/update?arg=<from-path>&arg=<to-path>&unpin=true"

/api/v0/pin/verify

驗(yàn)證遞歸pins是否完成玄柠。

參數(shù)

verbose [bool]: 是否輸出連續(xù)本地持久化對(duì)象的哈希值。是否必須: 否诫舅。
quiet [bool]: 是否僅輸出非連續(xù)本地持久化對(duì)象的哈希值羽利。是否必須: 否。

響應(yīng)

請(qǐng)求成功刊懈，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Cid": "<string>"
    "PinStatus": {
        "Ok": "<bool>"
        "BadNodes": [
            {
                "Cid": "<string>"
                "Err": "<string>"
            }
        ]
    }
}

cURL 示例

curl "http://localhost:5001/api/v0/pin/verify?verbose=<value>&quiet=<value>"

/api/v0/ping

向IPFS主機(jī)發(fā)送echo請(qǐng)求包这弧。

參數(shù)

arg [string]: 需要本地持久化的節(jié)點(diǎn) ID。是否必須: 是虚汛。
count [int]: 需要本地持久化節(jié)點(diǎn)的數(shù)量匾浪。默認(rèn): “10”。是否必須: 否卷哩。

響應(yīng)

請(qǐng)求成功蛋辈，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Success": "<bool>"
    "Time": "<int64>"
    "Text": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/ping?arg=<peer ID>&count=10"

/api/v0/pubsub/ls

按名稱列出訂閱的主題。

參數(shù)

此接口不需要傳入?yún)?shù)将谊。

響應(yīng)

請(qǐng)求成功冷溶，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/pubsub/ls"

/api/v0/pubsub/peers

列出我們現(xiàn)在正在連接的節(jié)點(diǎn)。

參數(shù)

arg [string]: 鏈接的節(jié)點(diǎn)列表的主題尊浓。是否必須: 否逞频。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

 curl "http://localhost:5001/api/v0/pubsub/peers?arg=<topic>"

/api/v0/pubsub/pub

將消息發(fā)布到給定的pubsub主題栋齿。

參數(shù)

arg [string]: 待發(fā)布的主題苗胀。是否必須: 是托酸。
arg [string]: 待發(fā)布消息的負(fù)載。是否必須: 是柒巫。

響應(yīng)

請(qǐng)求成功励堡，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/pubsub/pub?arg=<topic>&arg=<data>"

/api/v0/pubsub/sub

訂閱關(guān)于給定主題的消息。

參數(shù)

arg [string]: 要訂閱的主題的字符串名堡掏。是否必須: 是应结。
discover [bool]: 是否查找訂閱了相同主題的節(jié)點(diǎn)。是否必須: 否泉唁。

響應(yīng)

請(qǐng)求成功鹅龄，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Message": {
        "From": [
            "<uint8>"
        ]
        "Data": [
            "<uint8>"
        ]
        "Seqno": [
             "<uint8>"
        ]
        "TopicIDs": [
             "<string>"
        ]
        "XXX_unrecognized": [
            "<uint8>"
        ]
    }
}

cURL 示例

curl "http://localhost:5001/api/v0/pubsub/sub?arg=<topic>&discover=<value>"

/api/v0/refs/local

列出所有本地引用。

參數(shù)

此接口不需要傳入?yún)?shù)亭畜。

響應(yīng)

請(qǐng)求成功扮休，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Ref": "<string>"
    "Err": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/refs/local"

/api/v0/repo/fsck

移除repo鎖文件。

參數(shù)

此接口不需要傳入?yún)?shù)拴鸵。

響應(yīng)

請(qǐng)求成功玷坠，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Message": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/repo/fsck"

/api/v0/repo/gc

對(duì)repo執(zhí)行強(qiáng)制垃圾回收。

參數(shù)

quiet [bool]: 顯示最小輸出劲藐。默認(rèn): 否八堡。是否必須: 否。
stream-errors [bool]: 是否輸出 Stream 錯(cuò)誤聘芜。默認(rèn): 否兄渺。是否必須: 否。

響應(yīng)

請(qǐng)求成功汰现，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Key": "<string>"
    "Error": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/repo/gc?quiet=false&stream-errors=false"

/api/v0/repo/stat

獲取當(dāng)前repo的狀態(tài)信息挂谍。

參數(shù)

human [bool]: 是否以 MiB為單位輸出 RepoSize。默認(rèn): 否瞎饲。是否必須: 否口叙。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "NumObjects": "<uint64>"
    "RepoSize": "<uint64>"
    "RepoPath": "<string>"
    "Version": "<string>"
    "StorageMax": "<uint64>"
}

cURL 示例

 curl "http://localhost:5001/api/v0/repo/stat?human=false"

/api/v0/repo/verify

驗(yàn)證repo中的所有塊是否損壞企软。

參數(shù)

此接口不需要傳入?yún)?shù)庐扫。

響應(yīng)

請(qǐng)求成功饭望，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Message": "<string>"
    "Progress": "<int>"
}

cURL 示例

curl "http://localhost:5001/api/v0/repo/verify"

/api/v0/repo/version

顯示當(dāng)前repo版本仗哨。

參數(shù)

quiet [bool]: 是否顯示最小輸出。是否必須: 否铅辞。

響應(yīng)

請(qǐng)求成功厌漂，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Version": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/repo/version?quiet=<value>"

/api/v0/resolve

將名稱的值解析為IPFS。

參數(shù)

arg [string]: 待解析的名字斟珊。是否必須: 是苇倡。
recursive [bool]: 如果結(jié)果是 IPFS 名字，是否遞歸解析。默認(rèn): 否旨椒。是否必須: 否晓褪。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Path": "<string>"
}

cURL 示例

 curl "http://localhost:5001/api/v0/resolve?arg=<name>&recursive=false"

/api/v0/shutdown

關(guān)閉ipfs守護(hù)進(jìn)程综慎。

參數(shù)

此接口不需要傳入?yún)?shù)涣仿。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

 This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/shutdown"

/api/v0/stats/bitswap

顯示一些關(guān)于位交換代理的診斷信息示惊。

參數(shù)

此接口不需要傳入?yún)?shù)好港。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "ProvideBufLen": "<int>"
    "Wantlist": [
        "<string>"
    ]
    "Peers": [
        "<string>"
    ]
    "BlocksReceived": "<uint64>"
    "DataReceived": "<uint64>"
    "BlocksSent": "<uint64>"
    "DataSent": "<uint64>"
    "DupBlksReceived": "<uint64>"
    "DupDataReceived": "<uint64>"
}

cURL 示例

curl "http://localhost:5001/api/v0/stats/bitswap"

/api/v0/stats/bw

打印ipfs帶寬信息米罚。

參數(shù)

peer [string]: 指定需要打印帶寬的節(jié)點(diǎn)钧汹。是否必須: 否。
proto [string]: 指定需要打印帶寬的協(xié)議录择。是否必須: 否拔莱。
poll [bool]: 是否每隔一段時(shí)間打印帶寬。默認(rèn): 否隘竭。是否必須: 否辨宠。
interval [string]: 打印的時(shí)間間隔。

可以接受如“300s”, “1.5h” 或 “2h45m” 的時(shí)間區(qū)間货裹。有效的時(shí)間單位是: “ns”, “us” (or “μs”), “ms”, “s”, “m”, “h”嗤形。缺省: “1s”。是否必須：否弧圆。

響應(yīng)

請(qǐng)求成功赋兵，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "TotalIn": "<int64>"
    "TotalOut": "<int64>"
    "RateIn": "<float64>"
    "RateOut": "<float64>"
}

cURL 示例

curl 
"http://localhost:5001/api/v0/stats/bw?peer=<value>&proto=<value>&poll=false&interval=1s"

/api/v0/stats/repo

獲取當(dāng)前repo的狀態(tài)。

參數(shù)

human [bool]: 是否輸出 RepoSize搔预，以 MiB 為單位霹期。默認(rèn): 否。是否必須: 否拯田。

響應(yīng)

請(qǐng)求成功历造，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "NumObjects": "<uint64>"
    "RepoSize": "<uint64>"
    "RepoPath": "<string>"
    "Version": "<string>"
    "StorageMax": "<uint64>"
}

cURL 示例

curl "http://localhost:5001/api/v0/stats/repo?human=false"

/api/v0/swarm/addrs/listen

監(jiān)聽(tīng)地址列表界面。

參數(shù)

此接口不需要傳入?yún)?shù)船庇。

響應(yīng)

請(qǐng)求成功吭产，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/addrs/listen"

/api/v0/swarm/addrs/local

本地地址列表。

參數(shù)

id [bool]: 是否顯示地址列表中的節(jié)點(diǎn) ID鸭轮。默認(rèn): 否臣淤。是否必須: 否。

響應(yīng)

請(qǐng)求成功窃爷，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/addrs/local?id=false"

/api/v0/swarm/connect

打開(kāi)與給定地址的連接邑蒋。

參數(shù)

arg [string]: 需要連接的節(jié)點(diǎn)的地址姓蜂。是否必須: 是。

響應(yīng)

請(qǐng)求成功医吊，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/connect?arg=<address>"

/api/v0/swarm/disconnect

關(guān)閉與給定地址的連接钱慢。

參數(shù)

arg [string]: 需要關(guān)閉連接的節(jié)點(diǎn)地址。是否必須: 是卿堂。

響應(yīng)

請(qǐng)求成功滩字，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/disconnect?arg=<address>"

/api/v0/swarm/filters/add

添加一個(gè)地址過(guò)濾器。

參數(shù)

arg [string]: 需要添加的地址過(guò)濾器御吞。是否必須: 是麦箍。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/filters/add?arg=<address>"

/api/v0/swarm/filters/rm

刪除一個(gè)地址過(guò)濾器陶珠。

參數(shù)

arg [string]: 需要?jiǎng)h除的地址過(guò)濾器挟裂。是否必須: 是。

響應(yīng)

請(qǐng)求成功揍诽，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Strings": [
        "<string>"
    ]
}

cURL 示例

curl "http://localhost:5001/api/v0/swarm/filters/rm?arg=<address>"

/api/v0/swarm/peers

列出具有活躍連接的peers诀蓉。

參數(shù)

verbose [bool]: 是否展示全部信息。是否必須: 否暑脆。
streams [bool]: 是否列出每個(gè)節(jié)點(diǎn)的開(kāi)源流信息渠啤。是否必須: 否。
latency [bool]: 是否列出每個(gè)節(jié)點(diǎn)的延遲時(shí)間信息添吗。是否必須: 否沥曹。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Peers": [
        {
            "Addr": "<string>"
            "Peer": "<string>"
            "Latency": "<string>"
            "Muxer": "<string>"
            "Streams": [
                {
                    "Protocol": "<string>"
                }
            ]
        }
    ]
}

cURL 示例

 curl 
 "http://localhost:5001/api/v0/swarm/peers?verbose=<value>
 &streams=<value>&latency=<value>"

/api/v0/tar/add

將tar文件導(dǎo)入ipfs碟联。

參數(shù)

arg [file]: 需要添加的 Tar 文件妓美。是否必須: 是。

請(qǐng)求體

參數(shù) ‘file’ 是文件類型鲤孵。此接口需要請(qǐng)求體 ‘multipart/form-data’ 的文件壶栋。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Name": "<string>"
    "Hash": "<string>"
    "Bytes": "<int64>"
    "Size": "<string>"
}

cURL 示例

curl -F file=@myfile "http://localhost:5001/api/v0/tar/add"

/api/v0/tar/cat

從IPFS導(dǎo)出tar文件普监。

參數(shù)

arg [string]: tar文件的 ipfs 導(dǎo)出路徑贵试。是否必須: 是。

響應(yīng)

請(qǐng)求成功凯正，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/tar/cat?arg=<path>"

/api/v0/update

參數(shù)

arg [string]: 子命令的參數(shù)毙玻。是否必須: 否。

響應(yīng)

請(qǐng)求成功漆际，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

This endpoint returns a `text/plain` response body.

cURL 示例

curl "http://localhost:5001/api/v0/update?arg=<args>"

/api/v0/version

獲取ipfs版本信息淆珊。

參數(shù)

number [bool]: 是否只顯示版本號(hào)。默認(rèn): 否奸汇。是否必須: 否施符。
commit [bool]: 是否顯示 commit hash。默認(rèn): 否擂找。是否必須: 否戳吝。
repo [bool]: 是否顯示倉(cāng)儲(chǔ)版本。默認(rèn): 否贯涎。是否必須: 否听哭。
all [bool]: 是否顯示所有的版本信息。默認(rèn): 否塘雳。是否必須: 否陆盘。

響應(yīng)

請(qǐng)求成功，調(diào)用該路徑將返回 Code 200 及如下結(jié)果:

{
    "Version": "<string>"
    "Commit": "<string>"
    "Repo": "<string>"
    "System": "<string>"
    "Golang": "<string>"
}

cURL 示例

curl "http://localhost:5001/api/v0/version?number=false&commit=false&repo=false&all=false"

Tip打賞

翻譯 yangliu
ETH: 0x85d718C27a3eB0be78A5835C0805A7b1834A6B34

最后編輯于：2018.09.10 20:37:41

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末败明，一起剝皮案震驚了整個(gè)濱河市隘马，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌妻顶，老刑警劉巖酸员，帶你破解...
沈念sama閱讀 212,383評(píng)論 6贊 493
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場(chǎng)離奇詭異讳嘱，居然都是意外死亡幔嗦，警方通過(guò)查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 90,522評(píng)論 3贊 385
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門沥潭，熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)邀泉，“玉大人，你說(shuō)我怎么就攤上這事钝鸽『粼” “怎么了？”我有些...
開(kāi)封第一講書(shū)人閱讀 157,852評(píng)論 0贊 348
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵寞埠，是天一觀的道長(zhǎng)屁置。經(jīng)常有香客問(wèn)我，道長(zhǎng)仁连，這世上最難降的妖魔是什么蓝角？我笑而不...
開(kāi)封第一講書(shū)人閱讀 56,621評(píng)論 1贊 284
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮饭冬，結(jié)果婚禮上使鹅，老公的妹妹穿的比我還像新娘。我一直安慰自己昌抠，他們只是感情好患朱，可當(dāng)我...
茶點(diǎn)故事閱讀 65,741評(píng)論 6贊 386
惡毒庶女頂嫁案：這布局不是一般人想出來(lái)的
文/花漫我一把揭開(kāi)白布。她就那樣靜靜地躺著炊苫，像睡著了一般裁厅。火紅的嫁衣襯著肌膚如雪冰沙。梳的紋絲不亂的頭發(fā)上，一...
開(kāi)封第一講書(shū)人閱讀 49,929評(píng)論 1贊 290
城市分裂傳說(shuō)
那天执虹，我揣著相機(jī)與錄音拓挥，去河邊找鬼。笑死袋励，一個(gè)胖子當(dāng)著我的面吹牛侥啤，可吹牛的內(nèi)容都是我干的。我是一名探鬼主播茬故，決...
沈念sama閱讀 39,076評(píng)論 3贊 410
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開(kāi)眼盖灸，長(zhǎng)吁一口氣：“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來(lái)了磺芭？” 一聲冷哼從身側(cè)響起赁炎，我...
開(kāi)封第一講書(shū)人閱讀 37,803評(píng)論 0贊 268
萬(wàn)榮殺人案實(shí)錄
序言：老撾萬(wàn)榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎徘跪，沒(méi)想到半個(gè)月后甘邀，有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體，經(jīng)...
沈念sama閱讀 44,265評(píng)論 1贊 303
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡垮庐，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 36,582評(píng)論 2贊 327
?白月光啟示錄
正文我和宋清朗相戀三年松邪，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片哨查。...
茶點(diǎn)故事閱讀 38,716評(píng)論 1贊 341
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡逗抑，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出寒亥，到底是詐尸還是另有隱情邮府，我是刑警寧澤，帶...
沈念sama閱讀 34,395評(píng)論 4贊 333
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布溉奕，位于F島的核電站褂傀，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏加勤。R本人自食惡果不足惜仙辟，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 40,039評(píng)論 3贊 316
男人毒藥：我在死后第九天來(lái)索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望鳄梅。院中可真熱鬧叠国，春花似錦、人聲如沸戴尸。這莊子的主人今日做“春日...
開(kāi)封第一講書(shū)人閱讀 30,798評(píng)論 0贊 21
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽(yáng)。三九已至项棠，卻和暖如春悲雳，著一層夾襖步出監(jiān)牢的瞬間，已是汗流浹背沾乘。一陣腳步聲響...
開(kāi)封第一講書(shū)人閱讀 32,027評(píng)論 1贊 266
情欲美人皮
我被黑心中介騙來(lái)泰國(guó)打工怜奖，沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留浑测，地道東北人翅阵。一個(gè)月前我還...
沈念sama閱讀 46,488評(píng)論 2贊 361
代替公主和親
正文我出身青樓，卻偏偏與公主長(zhǎng)得像迁央，于是被迫代替她去往敵國(guó)和親掷匠。傳聞我的和親對(duì)象是個(gè)殘疾皇子，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 43,612評(píng)論 2贊 350