开发者社区 问答 正文

Swarm API参考  应用API列表  查看服务实例列表

[font=PingFangSC, "]查看您在容器集群中创建的所有服务实例列表。

请求信息


请求行 RequestLineGET /services/ HTTP/1.1
请求行参数 URI Param

[tr=rgb(51, 205, 229)][td]名称 类型是否必须描述qstring否服务名称containersboolean否是否包含服务的容器信息,缺省值 true
特有请求头 RequestHead

请求体 RequestBody


返回信息


返回行 ResponseLineHTT P/1.1 200 OK
特有返回头 ResponseHead

返回体 ResponseBody[{ "id": "string", "name": "string", "project": "string", "description": "string", "created": "datetime", "updated": "datetime", "desired_state": "string", "current_state": "string", "definition": { "key": "value",...}, "extensions": { "key": "value",...}, "containers": { "key": "value",...}},...]
返回体解释
服务实例的格式
[tr=rgb(51, 205, 229)][td]名称 类型描述idstring服务 IDnamestring服务名称projectstring应用名称createddatetime服务创建时间updateddatetime服务更新时间desired_statestring期望状态 (如果当前状态是中间状态时,期望状态指明变迁终态)current_statestring当前状态definitionmapCompose 中服务定义 key/valueextensionsmap容器服务 Compose 中服务扩展 key/valuecontainersmap服务中所包含容器 key (容器id)/value(属性)

示例


请求示例GET /services/ HTTP/1.1
返回示例
HTTP/1.1 200 Ok
Content-Type:application/json;charset=UTF-8
[
  {
    "id": "wordpress_db",
    "name": "db",
    "project": "wordpress",
    "definition": {
      "environment": [
        "MYSQL_ROOT_PASSWORD=password"
      ],
      "image": "mysql:5.7",
      "restart": "always"
    },
    "extensions": {
      "scale": 1,
      "logs": [
        "/var/log/mysql"
      ]
    },
    "created": "2016-04-21T13:36:32.440646459Z",
    "updated": "2016-04-21T13:36:33.270308958Z",
    "desired_state": "running",
    "current_state": "running",
    "containers": {
      "5616f05d27516b3502a391fd2ca9d312cabffa5ad431bf261ea81f4ceabd476e": {
        "name": "/wordpress_db_1",
        "node": "10.246.2.3",
        "ip": "10.0.0.2",
        "running": true,
        "status": "running",
        "health": "success"
      }
    }
  }
]


展开
收起
青蛙跳 2018-08-31 23:43:25 1816 分享 版权
阿里云 AI 助理回答

要查看您在容器集群中创建的所有服务实例列表,您可以发起一个HTTP GET请求到特定的API端点。以下是执行此操作的详细说明:

请求信息

  • 请求方法: GET
  • 请求URL: /services/
  • 协议版本: HTTP/1.1
  • 请求行参数:
    • q: (可选) 字符串类型,用于指定服务名称进行过滤。
    • containers: (可选) 布尔类型,默认值为true,表示是否返回服务包含的容器信息。

返回信息结构

响应将提供一个JSON格式的数组,其中包含了服务实例的详细信息。每个服务实例的信息包括但不限于以下字段:

  • id: 服务ID,字符串类型。
  • name: 服务名称,字符串类型。
  • project: 应用名称,字符串类型。
  • created: 服务创建时间,日期时间格式。
  • updated: 服务更新时间,日期时间格式。
  • desired_state: 期望状态,字符串类型,指示服务期望达到的状态。
  • current_state: 当前状态,字符串类型,表示服务当前的实际状态。
  • definition: 服务定义的键值对映射,来源于Compose文件中的服务定义。
  • extensions: 服务扩展的键值对映射,可能包含如扩缩容设置、日志路径等额外配置。
  • containers: 服务中所包含容器的映射,键为容器ID,值为包含容器属性的对象。

示例请求与响应

请求示例:

GET /services/ HTTP/1.1

响应示例:

[
    {
        "id": "wordpress_db",
        "name": "db",
        "project": "wordpress",
        "definition": {
            "environment": ["MYSQL_ROOT_PASSWORD=password"],
            "image": "mysql:5.7",
            "restart": "always"
        },
        "extensions": {
            "scale": 1,
            "logs": ["/var/log/mysql"]
        },
        "created": "2016-04-21T13:36:32.440646459Z",
        "updated": "2016-04-21T13:36:33.270308958Z",
        "desired_state": "running",
        "current_state": "running",
        "containers": {
            "5616f05d27516b3502a391fd2ca9d312cabffa5ad431bf261ea81f4ceabd476e": {
                "name": "/wordpress_db_1",
                "node": "10.246.2.3",
                "ip": "10.0.0.2",
                "running": true,
                "status": "running",
                "health": "success"
            }
        }
    }
]

请注意,实际使用时需根据您的具体环境调整请求URL和认证信息(如API密钥或Token),确保您有权限访问该API。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答