5.4 微服务实例
5.4.2 根据 service_id 查询微服务实例
功能介绍
实例注册后可以根据service_id发现该微服务的所有实例。
调试
您可以在API Explorer中调试该接口。
URI
GET /v4/{project_id}/registry/microservices/{service_id}/instances
表5-86 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户子项目的唯一标识，字符长 度为1~64
service_id 是 String 微服务唯一标识。字符长度为 1~64。正则表达式为^.*$
表5-87 Query 参数
参数 是否必选 参数类型 描述
tags 否 String Tag标签过滤，多个时逗号分
隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$
env 否 String 实例的环境信息：
development、testing、
acceptance、production
请求参数
表5-88 请求 Header 参数
参数 是否必选 参数类型 描述
X-ConsumerId 否 String 微服务消费者的微服务唯一标 识。
Authorization 否 String 若微服务引擎专享版开启了安全 认证，此参数必填。
请参考访问开启了安全认证的微
响应参数
状态码： 200
表5-89 响应 Body 参数
参数 参数类型 描述
instances Array of
MicroServiceI nstance
objects实例列表。
表5-90 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-91 HealthCheck
参数 参数类型 描述
mode String 心跳模式push/pull。
参数 参数类型 描述 port Integer 端口。
interval Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。
times Integer 允许失败次数，不允许小于0。
表5-92 DataCenterInfo
参数 参数类型 描述
name String 区域名字
region String 区域 availableZone String 可获取区
状态码： 400
表5-93 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
状态码： 500
表5-94 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
请求示例
GET https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances
查询成功。
{ "instances" : [ { "instanceId" : "string", "serviceId" : "string", "version" : "string", "hostName" : "string",
"endpoints" : [ "string", "string" ], "status" : "string", "availableZone" : "string"
},
"timestamp" : "string", "modTimestamp" : "string"
} ]
您可以在API Explorer中调试该接口。
URI
DELETE /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}
表5-95 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户子项目的唯一标识。字符长 度为1~64
service_id 是 String 微服务唯一标识。字符长度为 1~64。正则表达式为^.*$
instance_id 是 String 微服务实例唯一标识。字符长度 不超过64位。 正则表达式为
^[A-Za-z0-9_.-]*$
请求参数
表5-96 请求 Header 参数
参数 是否必选 参数类型 描述
Authorization 否 String 若微服务引擎专享版开启了安全 认证，此参数必填。
请参考访问开启了安全认证的微
服务引擎专享版的接口
响应参数
状态码： 400
表5-97 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
状态码： 500
表5-98 响应 Body 参数
参数 参数类型 描述
errorCode String
参数 参数类型 描述
detail String 详细定位信息。
请求示例
DELETE https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}
响应示例
无
状态码
状态码 描述
200 注销成功。
400 错误的请求。
500 服务内部错误。
错误码
请参见ServiceComb错误码。
5.4.4 查询微服务实例详细信息
功能介绍
实例注册后可以根据service_id和instance_id获取该实例的详细信息。
调试
您可以在API Explorer中调试该接口。
URI
GET /v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}
表5-99 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 租户子项目的唯一标识。字符长 度为1~64
service_id 是 String 微服务唯一标识。字符长度为 1~64。正则表达式为^.*$
参数 是否必选 参数类型 描述
instance_id 是 String 微服务实例唯一标识。字符长度 不超过64位。 正则表达式为
^[A-Za-z0-9_.-]*$
表5-100 Query 参数
参数 是否必选 参数类型 描述
tags 否 String Tag标签过滤，多个时逗号分
隔。正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$
env 否 String 实例的环境信息：
development、testing、
acceptance、production
请求参数
表5-101 请求 Header 参数
参数 是否必选 参数类型 描述
X-consumerId 是 String 微服务消费者的微服务唯一标 识。
Authorization 否 String 若微服务引擎专享版开启了安全 认证，此参数必填。
请参考访问开启了安全认证的微
服务引擎专享版的接口
响应参数
状态码： 200
表5-102 响应 Body 参数
参数 参数类型 描述
instance
MicroServiceI nstance
object微服务实例信息。
表5-103 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-104 HealthCheck
参数 参数类型 描述
mode String 心跳模式push/pull。
port Integer 端口。
interval Integer 心跳间隔（秒），当值小于5秒时，按5秒注册。
times Integer 允许失败次数，不允许小于0。
表5-105 DataCenterInfo
参数 参数类型 描述
name String 区域名称
region String 区域
参数 参数类型 描述 availableZone String 可获取区
状态码： 400
表5-106 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
状态码： 500
表5-107 响应 Body 参数
参数 参数类型 描述
errorCode String 错误代码。
errorMessage String 错误信息。
detail String 详细定位信息。
请求示例
GET https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/instances/{instance_id}
响应示例
状态码： 200 查询成功。
{ "instance" : {
"instanceId" : "string", "serviceId" : "string", "version" : "string", "hostName" : "string",
"endpoints" : [ "string", "string" ], "status" : "string",
"null" : null, "healthCheck" : { "mode" : "string", "port" : 0, "interval" : 0,
"name" : "string", "region" : "string", "availableZone" : "string"
},
"timestamp" : "string", "modTimestamp" : "string"
}}
状态码
状态码 描述
200 查询成功。
400 错误的请求。
500 服务内部错误。
错误码
请参见ServiceComb错误码。