portainer的接口详细信息
时间: 2023-09-14 11:13:49 浏览: 34
Portainer 提供了丰富的 REST API 接口,可以用于管理 Docker 容器、镜像、网络等资源。下面是一些常用接口的详细信息:
1. 获取 Docker 版本信息
- API URL: /api/docker/version
- 请求方法: GET
- 返回结果: 包含 Docker 版本号和 API 版本号的 JSON 对象
2. 获取所有容器信息
- API URL: /api/docker/containers/json
- 请求方法: GET
- 返回结果: 包含所有容器信息的 JSON 数组
3. 获取单个容器信息
- API URL: /api/docker/containers/{id}/json
- 请求方法: GET
- 请求参数: id,容器 ID
- 返回结果: 包含指定容器信息的 JSON 对象
4. 启动一个容器
- API URL: /api/docker/containers/{id}/start
- 请求方法: POST
- 请求参数: id,容器 ID
- 返回结果: 无
5. 停止一个容器
- API URL: /api/docker/containers/{id}/stop
- 请求方法: POST
- 请求参数: id,容器 ID
- 返回结果: 无
6. 获取所有镜像信息
- API URL: /api/docker/images/json
- 请求方法: GET
- 返回结果: 包含所有镜像信息的 JSON 数组
7. 获取单个镜像信息
- API URL: /api/docker/images/{id}/json
- 请求方法: GET
- 请求参数: id,镜像 ID
- 返回结果: 包含指定镜像信息的 JSON 对象
8. 搜索镜像
- API URL: /api/docker/images/search
- 请求方法: GET
- 请求参数: term,搜索关键字
- 返回结果: 包含搜索结果的 JSON 数组
9. 删除一个镜像
- API URL: /api/docker/images/{id}
- 请求方法: DELETE
- 请求参数: id,镜像 ID
- 返回结果: 无
10. 获取所有网络信息
- API URL: /api/docker/networks
- 请求方法: GET
- 返回结果: 包含所有网络信息的 JSON 数组
11. 获取单个网络信息
- API URL: /api/docker/networks/{id}
- 请求方法: GET
- 请求参数: id,网络 ID
- 返回结果: 包含指定网络信息的 JSON 对象
12. 创建一个网络
- API URL: /api/docker/networks/create
- 请求方法: POST
- 请求参数: name,网络名称;driver,网络驱动名称
- 返回结果: 包含创建的网络信息的 JSON 对象
13. 删除一个网络
- API URL: /api/docker/networks/{id}
- 请求方法: DELETE
- 请求参数: id,网络 ID
- 返回结果: 无
以上是一些常用接口的详细信息,Portainer 还提供了很多其他接口用于管理 Docker 等资源。需要注意的是,访问这些接口需要管理员权限。