文档首页 > > API参考> CSE API> 微服务实例>

根据service_id查询微服务实例

根据service_id查询微服务实例

分享
更新时间:2021/05/26 GMT+08:00

功能介绍

实例注册后可以根据 service_id 发现该微服务的所有实例。

调试

您可以在API Explorer中调试该接口。

URI

GET /v4/{project_id}/registry/microservices/{service_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户子项目的唯一标识。字符长度为1~64。

service_id

String

微服务唯一标识。字符长度为1~64。正则表达式为^.*$

表2 Query参数

参数

是否必选

参数类型

描述

tags

String

Tag标签过滤,多个时逗号分隔。 正则表达式为^[a-zA-Z][a-zA-Z0-9_-.]{0,63}$

env

String

实例的environment。development|testing|acceptance|production

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-domain-name

String

租户帐号名称。

X-consumer_id

String

微服务消费者的微服务唯一标识。

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of MicroServiceInstance objects

实例列表。

表5 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

健康检查信息。

dataCenterInfo

DataCenterInfo object

数据中心信息。

timestamp

String

实例创建时间戳,自动生成

modTimestamp

String

更新时间

表6 HealthCheck

参数

参数类型

描述

mode

String

心跳模式 push/pull。

port

Integer

端口。

interval

Integer

心跳间隔(秒)。

times

Integer

允许失败次数。

表7 DataCenterInfo

参数

参数类型

描述

name

String

区域名字

region

String

区域

availableZone

String

可获取区

状态码: 400

表8 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

GET https://{endpoint}/v4/{project_id}/registry/existence

响应示例

状态码: 200

查询成功。

{
  "instances" : [ {
    "instanceId" : "string",
    "serviceId" : "string",
    "version" : "string",
    "hostName" : "string",
    "endpoints" : [ "string", "string" ],
    "status" : "string",
    "null" : null,
    "healthCheck" : {
      "mode" : "string",
      "port" : 0,
      "interval" : 0,
      "times" : 0
    },
    "dataCenterInfo" : {
      "name" : "string",
      "region" : "string",
      "availableZone" : "string"
    },
    "timestamp" : "string",
    "modTimestamp" : "string"
  } ]
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品