九游平台/ 弹性云服务器 ecs/ api参考/ api/ 云服务器组管理/ 查询云服务器组列表
更新时间：2023-07-06 gmt 08:00
查看pdf

查询云服务器组列表-九游平台

功能介绍

查询云服务器组列表。

调试

您可以在中调试该接口。

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

云服务器组信息。更多信息请参见表4。

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：此组中的云服务器必须安排到不同的主机。
表5 page_info数据结构说明

参数

参数类型

描述

next_marker

string

云服务器组的uuid。

请求示例

查询云服务器组列表。

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

响应示例

{
   "server_groups": [
      {
         "members": [],
         "metadata": {},
         "id": "318b44a7-f7a6-4c0b-8107-e8bd618b28dd",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "svrgrp-b9d6"
  },
  {
         "members": [],
         "metadata": {},
         "id": "b8f4cfc4-9a59-498c-9b52-643ee6515cd0",
         "policies": [
                     "anti-affinity"
                     ],
         "name": "svrgrp-10a1"
  }
 ]
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。

父主题： 云服务器组管理

相关文档

网站地图