查询云服务器组列表ListServerGroups
.jpg)
.jpg)
.jpg)
.jpg)
接口说明
查询弹性 云服务器 组。
与原生的创建云服务器组接口不同之处在于该接口支持企业项目细粒度权限的校验。
约束说明
无
URL
GET https://ecs.cn-north-1.myhuaweicloud.com/v1/{project_id}/cloudservers/os-server-groups
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。 通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
|
project_id
|
string | path | 是 |
项目ID。 |
|
limit
|
integer | query | 否 |
查询返回server group数量限制。 |
|
marker
|
string | query | 否 |
从marker指定的server group的下一条数据开始查询。 |
返回参数
返回码: 200
OK
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
server_groups
|
Array of ListServerGroupsResult objects | 是 |
弹性云服务器组信息 |
|
page_info
|
ListServerGroupsPageInfoResult object | 否 |
200 server_groups
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
id
|
string | 是 |
云服务器组UUID。 |
|
members
|
Array of strings | 是 |
云服务器组中包含的云服务器列表。 |
|
metadata
|
Map<String,String> | 是 |
云服务器组元数据。 |
|
name
|
string | 是 |
云服务器组名称。 |
|
policies
|
Array of strings | 是 |
与服务器组关联的策略名称列表。当前有效的策略名称为: anti-affinity -此组中的服务器必须安排到不同的主机; affinity -此组中的服务器必须安排在同一主机上; soft-anti-affinity –如果可能, 应将此组中的服务器安排到不同的主机, 但如果无法实现, 则仍应安排它们, 而不是导致生成失败; soft-affinity -如果可能, 应将此组中的服务器安排在同一主机上, 但如果无法实现, 则仍应安排它们, 而不是导致生成失败。 |
200 page_info
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
next_marker
|
string | 否 |
请求示例
示例 1
"GET https://{endpoint}/v1/9c53a566cb3443ab910cf0daebca90c4/cloudservers/os-server-groups"
返回示例
返回码：200
OK
示例 1
{
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "test",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
]
}
"server_groups": [
{
"id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
"name": "test",
"policies": [
"anti-affinity"
],
"members": [],
"metadata": {}
}
]
}
SDK
点击 弹性云服务器 (ECS) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
