弹性云服务器 ECS弹性云服务器 ECS

更新时间:2021/08/17 GMT+08:00
分享

查询云服务器组列表

功能介绍

查询云服务器组列表。

URI

GET /v1/{project_id}/cloudservers/os-server-groups?limit={limit}&marker={marker}

参数说明请参见表1
表1 路径参数

参数

是否必选

描述

project_id

项目ID。

获取方法请参见获取项目ID

表2 查询参数

参数

是否必选

参数类型

描述

limit

Integer

查询返回server group数量限制,最大值1000。

marker

String

从marker指定的server group的下一条数据开始查询。

marker必须和limit配合使用,marker不能独立使用。

请求消息

响应消息

响应参数如表3所示。

表3 响应参数

参数

参数类型

描述

server_groups

Array of objects

云服务器组信息。

page_info

Object

当选择分页功能时返回当前页最后一个云服务器组的UUID信息。更多信息请参见表5

表4 server_groups参数信息

参数

参数类型

描述

id

String

云服务器组UUID。

name

String

云服务器组名称。

members

Array of strings

云服务器组中包含的云服务器列的ID列表。

metadata

Object

云服务器组元数据。

policies

Array of strings

云服务器组关联的策略名称列表。包括:
  • anti-affinity:此组中的云服务器必须安排到不同的主机。
  • affinity:此组中的云服务器必须安排在同一主机上。
  • soft-anti-affinity:如果可能,应将此组中的云服务器尽量安排到不同的主机上,但如果无法实现,则仍应安排它们,而不是导致生成失败。
  • soft-affinity:如果可能,应将此组中的云服务器尽量安排在同一主机上, 但如果无法实现,则仍应安排它们,而不是导致生成失败。
说明:

当前仅支持反亲和性anti-affinity策略。不建议使用其他策略。如果使用其他策略云服务器组可能会创建失败。

表5 page_info数据结构说明

参数

参数类型

描述

next_marker

String

云服务器组的UUID。

请求示例

GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups

响应示例

{
    "server_groups": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "name": "test",
            "policies": ["anti-affinity"],
            "members": [],
            "metadata": {}
        }
    ],
    "page_info": {
        "next_marker": "616fb98f-46ca-475e-917e-2563e5a8cd19"
    }
}

返回值

请参考通用请求返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品