docker-remote-api中文文档|docker-remote-api js中文教程|解析

npm npmdoc 2年前 (2022-01-01) 449次浏览

docker-remote-api中文文档|docker-remote-api js中文教程|解析

安装命令:npm i docker-remote-api

docker-remote-api

用于从节点调用 docker 远程 api 的基本 http 包装器

npm install docker-remote-api

构建状态

用法

var docker = require('docker-remote-api')
var request = docker({
  host: '/var/run/docker.sock'
})
 
request.get('/images/json', {json:true}, function(err, images) {
  if (err) throw err
  console.log('images', images)
})
 
request.get('/images/json', function(err, stream) {
  if (err) throw err
  // stream is a raw response stream
})

应用程序接口

request = docker(options)

options.host应该是 docker 实例的地址,即/var/run/docker.sock127.0.0.1:2375所有其他选项将用作get, post, put, 的默认值delete

如果省略options.host它,它将被设置为$DOCKER_HOST/var/run/docker.sock

request.get(path, [options], cb)

GET向远程 api发送请求。path应该是请求路径,即/images/json
options可以包含以下内容

{
  qs: {foo:'bar'},        // set querystring parameters
  headers: {name: '...'}, // set request headers
  json: true,             // return json instead of a stream
  buffer: true,           // return a buffer instead of a stream
  drain: true,            // will drain the response stream before calling cb
  timeout: 20000,         // set request timeout
  version: 'v1.14'        // set explicit api version
}

request.delete(path, [options], cb)

发送DELETE请求。类似的选项request.get

post = request.post(path, [options], cb)

发送POST请求。类似的选项,request.get除了它返回一个请求流,您可以通过管道将请求正文传输到该请求流。如果您发送的JSON可以设置options.json = body
body将字符串化,并将其作为请求主体。

如果您没有设置请求正文body: null或记得调用post.end()

put = request.put(path, [options], cb)

发送PUT请求。类似的选项request.post

执照

麻省理工学院

项目贡献人员列表:


极客公园 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:docker-remote-api中文文档|docker-remote-api js中文教程|解析
喜欢 (0)
.excerpt .focus {display:none}