接口说明
查询实例所在群组信息。
URL
POST https://ecloud.10086.cn/api/openapi-instance/v4/instance-group/details
请求参数
Body
|
参数名称
|
类型
|
必填
|
描述
|
|
detailInstanceGroupReq
|
DetailInstanceGroupReq
|
是
|
detailInstanceGroupReq |
|
instanceIds
|
<string> array
|
是
|
实例ID数组，可通过查询实例状态列表接口获取。 |
请求示例
POST https://ecloud.10086.cn/api/openapi-instance/v4/instance-group/details{
"instanceIds":[
"39a9882-30c8-44c7-8bce-321f2d2d591b"
]
}返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
<InstanceGroupDetailResp> array
|
请求成功时返回的数据。 |
|
groupId
|
string
|
实例群组ID，若为空，则当前实例无群组。 |
|
groupName
|
string
|
实例群组名称，若为空，则当前实例无群组。 |
|
instanceId
|
string
|
实例ID。 |
|
policy
|
string
|
实例群组策略。取值范围： - anti-affinity：强反亲和策略。 - soft-anti-affinity：弱反亲和策略。 - affinity：强亲和策略。 - soft-affinity：弱亲和策略。 |
|
result
|
boolean
|
实例是否绑定群组。 |
|
zoneId
|
string
|
可用区ID。 |
|
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-bb15dfdf-f7eb-4303-895a-cfffb13269d5",
"body":[
{
"instanceId":"39a9882-30c8-44c7-8bce-321f2d2d591b",
"groupId":"b7195376-6196-49ad-9411-17f39d88332c",
"groupName":"groupName",
"policy":"anti-affinity",
"zoneId":"cn-jiangsu-1a",
"result":true
}
],
"state":"OK"
}