接口说明
该接口用于查询云主机群组列表。
URL
GET https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/serverGroup/list
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
queryWord
|
string
|
否
|
模糊搜索(云主机群组名或ID)。 |
|
region
|
string
|
否
|
可用区。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-ecs/acl/v3/server/serverGroup/list返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
分页查询统一返回结构体«主机组详情»
|
请求成功时返回的数据 |
|
content
|
<主机组详情> array
|
分页查询返回的具体结构体 |
|
createdBy
|
string
|
创建人用户ID |
|
createdTime
|
string(date-time)
|
云主机群组创建时间 |
|
customed
|
boolean
|
云主机群组是否为客户自创 |
|
customerId
|
string
|
客户ID |
|
groupId
|
string
|
云主机群组ID |
|
groupName
|
string
|
云主机群组名称 |
|
modifiedBy
|
string
|
修改人用户ID |
|
modifiedTime
|
string(date-time)
|
群组修改时间 |
|
policy
|
enum(anti-affinity,affinity,soft-anti-affinity,soft-affinity)
|
云主机群组策略;anti-affinity:反亲和,affinity:亲和,soft-anti-affinity:弱反亲和,soft-affinity:弱亲和 |
|
quotaQuantity
|
integer
|
最大配额数量 |
|
region
|
string
|
可用区 |
|
serverCount
|
integer(int64)
|
云主机数量 |
|
total
|
integer
|
满足查询条件的总个数 |
|
errorCode
|
string
|
统一错误码 |
|
errorMessage
|
string
|
页面国际化错误提示 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数 |
|
requestId
|
string
|
每个请求的序列号 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码;返回正常：OK,返回错误：ERROR,返回异常：EXCEPTION,需要告警实现的：ALARM,禁止访问：FORBIDDEN |
返回示例
返回码：200
OK
{
"requestId":"reqId-***",
"state":"OK",
"body":{
"total":1,
"content":[
{
"groupId":"20c69629-1a7e-4664-ae26-***",
"groupName":"test-4",
"customerId":"CIDC-A-***",
"createdBy":"CIDC-U-***",
"createdTime":"2025-01-15 16:26:15",
"modifiedBy":null,
"modifiedTime":null,
"region":"N0512-JS-SZFH02",
"serverCount":0,
"quotaQuantity":16,
"customed":true,
"policy":"soft-anti-affinity"
}
]
}
}