本文导读

功能介绍
接口约束
URI
请求参数
响应参数
请求示例
响应示例
状态码
错误码

展开导读

文档首页/ 微服务引擎 CSE/ API参考/ ServiceComb API/ 微服务/ 查询指定微服务信息

查询指定微服务信息

更新时间：2024-01-29 GMT+08:00

查看PDF

功能介绍

根据service_id查询微服务定义信息。

接口约束

无

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	请填固定值：default。
service_id	是	String	微服务唯一标识。字符长度为1~64，正则表达式为^.*$，获取方法请参考查询所有微服务信息。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	否	String	若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取ServiceComb引擎专享版用户Token。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
service	MicroService object	微服务信息。

表4 MicroService
参数	参数类型	描述
serviceId	String	微服务唯一标识。字符长度为1~64。正则表达式为^.*$。
environment	String	用于区分微服务环境，取值为development、testing、acceptance、production。
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	详细定位信息。

请求示例

查询ID为819706e21b7173306797d19922ce4231441c17c5的微服务的详细信息。

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

响应示例

状态码： 200

查询成功。

{
    "service": {
        "serviceId": "819706e21b7173306797d19922ce4231441c17c5",
        "appId": "default",
        "serviceName": "SERVICECENTER",
        "version": "2.4.8",
        "level": "BACK",
        "schemas": [
            "servicecenter.grpc.api.ServiceCtrl",
            "servicecenter.grpc.api.ServiceInstanceCtrl"
        ],
        "status": "UP",
        "timestamp": "1616426688",
        "modTimestamp": "1616426688",
        "environment": "development"
    }
}

状态码

状态码	描述
200	查询成功。
400	错误的请求。
500	服务内部错误

错误码

请参见错误码。

父主题： 微服务

上一篇：微服务

下一篇：删除微服务定义信息

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消