5.4 微服务实例
5.4.9 批量查询微服务实例
"timestamp" : "string", "modTimestamp" : "string"
} ]
您可以在API Explorer中调试该接口。
URI
POST /v4/{project_id}/registry/instances/action
表5-131 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户子项目的唯一标识，字符长 度为1~64。
表5-132 Query 参数
参数 是否必选 参数类型 描述
type 是 String 操作，目前仅有“query”，表
示查询。
请求参数
表5-133 请求 Header 参数
参数 是否必选 参数类型 描述
X-consumerId 是 String 微服务消费者的微服务唯一标 识。
Authorization 否 String 若微服务引擎专享版开启了安全 认证，此参数必填。
请参考访问开启了安全认证的微
服务引擎专享版的接口
表5-134 请求 Body 参数
参数 是否必选 参数类型 描述
services 否 Array of
FindService
objects查询服务信息结构体。
instances 否 Array of
FindInstance
objects查询实例信息结构体。
说明
调用接口时，services和instances至少要有一个存在。
表5-135 FindService
参数 是否必选 参数类型 描述
service 否
Dependency
Key object
依赖关系条目。rev 否 String 客户端缓存的版本号。
表5-136 DependencyKey
参数 是否必选 参数类型 描述
environment 否 String 环境信息：development、
testing、aceptance、
production。
appId 是 String 应用app唯一标识。
serviceName 是 String 微服务名称。
表5-137 FindInstance
参数 是否必选 参数类型 描述
instance 否
HeartbeatSet Element
object微服务实例请求结构体。
rev 否 String 客户端缓存的版本号。
表5-138 HeartbeatSetElement
参数 是否必选 参数类型 描述
serviceId 否 String 微服务id instanceId 否 String 微服务实例id
响应参数
状态码： 200
表5-139 响应 Body 参数
参数 参数类型 描述
services
BatchFindResult object
批量查询结果结构体。instances
BatchFindResult object
批量查询结果结构体。表5-140 BatchFindResult
参数 参数类型 描述
failed Array of FindFailedResult
objects 查询失败结果结构体。
参数 参数类型 描述
notModified Array of integers 与请求数组对应的索引集合。
updated Array of FindResult objects 查询结果结构体列表。
表5-141 FindFailedResult
参数 参数类型 描述
indexes Array of integers 与请求数组对应的索引集合。
error
Error object
异常错误结构体。表5-142 Error
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
表5-143 FindResult
参数 参数类型 描述
index Integer 与请求数组对应的索引。
rev String 服务端返回集合版本，如跟客户
端缓存版本号一致，则instances 为空。
instances Array of
MicroServiceInstance
objects实例列表。
表5-144 MicroServiceInstance
参数 参数类型 描述
instanceId String 实例id，唯一标识。创建实例，instanceId由 service-center产生。
serviceId String 微服务唯一标识，创建实例时，以url里面的为 准，不用这里的serviceId。
参数 参数类型 描述
version String 微服务版本号。
hostName String 主机信息。
endpoints Array of
strings 访问地址信息。
status String 实例状态：UP、DOWN、STARTING、
OUTOFSERVICE。默认值UP。
properties Object 微服务扩展属性，可以自定义KEY和相应的 Value。长度最小1字节。
healthCheck
HealthCheck
object 健康检查信息。
dataCenterInf
o
DataCenterIn
fo object
数据中心信息。timestamp String 实例创建时间戳，自动生成。
modTimesta
mp String 更新时间。
表5-145 HealthCheck
参数 参数类型 描述
mode String 心跳模式push/pull。
port Integer 端口。
interval Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。
times Integer 允许失败次数，不允许小于0。
表5-146 DataCenterInfo
参数 参数类型 描述
name String 区域名称
region String 区域 availableZone String 可获取区
状态码： 400
表5-147 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
状态码： 500
表5-148 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
请求示例
POST https://{endpoint}/v4/{project_id}/registry/instances/action { "services" : [ {
"service" : {
"appId" : "TestApp",
"serviceName" : "helloworld1"
},
"rev" : "1.0.0"
}, {
"service" : {
"appId" : "TestApp",
"serviceName" : "helloworld2"
},
"updated" : [ {
状态码
状态码 描述
200 查询成功。
400 错误的请求。
500 服务内部错误。
错误码
请参见ServiceComb错误码。