应用管理与运维平台 ServiceStage应用管理与运维平台 ServiceStage

更新时间:2021/06/25 GMT+08:00
分享

查询所有微服务信息

功能介绍

根据条件组合,查询满足所有条件的微服务定义信息。

接口约束

调试

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

URI

GET /v4/{project_id}/registry/microservices

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-domain-name

String

租户帐号名称。

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

services

Array of MicroService objects

微服务列表。

表4 MicroService

参数

参数类型

描述

serviceId

String

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

environment

String

用于区分服务阶段,取值为development|testing|acceptance|production。当配置为development、testing或acceptance时,可以通过批量上传schemas接口新增或者修改已存在的Schema;当配置为production时,则不可以新增或者修改Schema。默认值development。

appId

String

应用App唯一标识。字符长度为1~160。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$

serviceName

String

微服务名称,同一个App要保证唯一。字符长度为1~128。 正则表达式为^[a-zA-Z0-9]$|^[a-zA-Z0-9][a-zA-Z0-9_-.][a-zA-Z0-9]$

version

String

微服务版本号。字符长度为1~64。 正则表达式为^[0-9]$|^[0-9]+(.[0-9]+)$

description

String

微服务描述信息。字符长度不超过256。

level

String

微服务层级。FRONT MIDDLE BACK

registerBy

String

微服务注册方式,SDK PLATFORM SIDECAR UNKNOWN

schemas

Array of strings

微服务访问的契约内容。支持数字、字母,支持使用括号内字符做连接符(_-.),长度1-160字节,数组长度最大100个契约。

status

String

微服务状态,UP表示上线,DOWN表示下线,默认值UP

枚举值:

  • UP

  • DOWN

timestamp

String

微服务注册时间。

modTimestamp

String

最后修改UTC时间。

framework

Framework object

开发框架信息。

paths

Array of ServicePath objects

服务路由信息。

表5 Framework

参数

参数类型

描述

name

String

微服务开发框架,默认值为UNKNOWN。

version

String

微服务开发框架版本号。

表6 ServicePath

参数

参数类型

描述

Path

String

路由地址

Property

Object

微服务扩展属性,可以自定义 KEY 和相应的 Value。长度最小1字节。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

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

响应示例

状态码: 200

查询成功。

{
  "services" : [ {
    "serviceId" : "string",
    "environment" : "string",
    "appId" : "string",
    "serviceName" : "string",
    "version" : "string",
    "description" : "string",
    "level" : "string",
    "registerBy" : "string",
    "schemas" : [ "string" ],
    "status" : "UP",
    "timestamp" : "string",
    "modTimestamp" : "string",
    "framework" : {
      "name" : "string",
      "version" : "string"
    },
    "paths" : [ {
      "Path" : "string"
    } ]
  } ]
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品