接口说明
查询实例群组列表。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/instance-group/list
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
queryWord
|
string
|
否
|
模糊搜索( |
|
zoneId
|
string
|
否
|
可用区，可通过查询属地地域可用区信息接口获取。示例值：苏州可用区1的zoneId为cn-jiangsu-1a。 |
|
page
|
integer(int32)
|
否
|
页码。默认值：1。 |
|
pageSize
|
integer(int32)
|
否
|
每页数量，取值范围：[1,100]。默认值：10。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/instance-group/list返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstanceGroupDetailInfo»
|
请求成功时返回的数据。 |
|
content
|
<InstanceGroupDetailInfo> array
|
分页查询返回的具体结构体。 |
|
createdBy
|
string
|
创建人用户ID。 |
|
createdTime
|
string(date-time)
|
群组创建时间。 |
|
customerId
|
string
|
客户ID。 |
|
groupId
|
string
|
群组ID。 |
|
groupName
|
string
|
群组名称。 |
|
instanceCount
|
integer(int64)
|
实例数量。 |
|
modifiedBy
|
string
|
修改人用户ID。 |
|
modifiedTime
|
string(date-time)
|
群组修改时间。 |
|
policy
|
string
|
实例群组策略。取值范围： - anti-affinity：强反亲和策略。- soft-anti-affinity：弱反亲和策略。- affinity：强亲和策略。- soft-affinity：弱亲和策略。 |
|
quotaQuantity
|
integer(int32)
|
最大配额数量。 |
|
zoneId
|
string
|
可用区。 |
|
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-627c7e06f6774006d2335-fdc213d1-6",
"state":"OK",
"body":{
"total":1,
"content":[
{
"groupId":"810a8096-5ee3-4088-1q9c-3e560cb1ab86",
"groupName":"testGroup",
"customerId":"CIDC-A-***",
"createdBy":"CIDC-U-***",
"createdTime":"2025-03-04 19:05:01",
"modifiedBy":null,
"modifiedTime":null,
"zoneId":"cn-jiangsu-1a",
"instanceCount":0,
"quotaQuantity":16,
"policy":"soft-anti-affinity"
}
]
}
}