- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
- 用户指南
- 最佳实践
- 开发指南
- API参考
- SDK参考
-
常见问题
- 使用华为云CSE注意事项
- Nacos引擎
-
ServiceComb引擎
- 如何进行本地开发和测试？
- 证书加载错误
- 无效头名称
- mesher性能损耗是多少？
- 连接服务中心提示“Version validate failed”
- 连接服务中心提示“Not enough quota”
- 如何处理开启了安全认证的ServiceComb引擎专享版开启IPv6后服务注册失败？
- 服务名重复校验范围是什么？
- 为什么一定要定义服务契约？
- 如何解决微服务应用开发过程中微服务开发框架同netty版本不匹配的问题？
- ServiceComb专享版引擎版本从1.x升级到2.x时有哪些注意事项？
- 用户业务从微服务引擎专业版迁移到微服务引擎专享版checklist
- 创建引擎提示“Duplicate cluster name”
- 创建引擎过程中处理接入地址步骤失败，提示the subnet could not be found
- 本地轻量化注册服务报错：does not match rule: {Max: 100, Regexp: ^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9][a-zA-Z0-9_\-.]{0,158}[a-zA-Z0-9]$}"}
- SpringCloud应用连接ServiceComb引擎2.x版本配置中心失败
- 在全局配置中配置相关的配置项修改后，服务获取的配置内容未修改成功
- 获取配置失败
- 视频帮助
- 通用参考
链接复制成功！
查询微服务契约
功能介绍
根据service_id和schema_id查询微服务的契约信息。
接口约束
无
URI
GET /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
请填固定值：default。 |
|
service_id |
是 |
String |
微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 |
|
schema_id |
是 |
String |
契约的id。获取方法请参考查询微服务的所有契约。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Authorization |
否 |
String |
若ServiceComb引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的ServiceComb引擎专享版Token，格式为： Authorization:Bearer {Token}Token获取方法，请参考获取ServiceComb引擎专享版用户Token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Schema-Summary |
String |
微服务契约的摘要。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
schema |
String |
契约内容。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误代码。 |
|
errorMessage |
String |
错误信息。 |
|
detail |
String |
详细定位信息。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误代码。 |
|
errorMessage |
String |
错误信息。 |
|
detail |
String |
详细定位信息。 |
请求示例
查询指定service_id和schema_id的契约的详细信息。
GET https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id}响应示例
状态码： 200
查询成功，如果summary存在，则header里面的X-Schema-Summary的value为该schema对应的摘要。
{
"schema" : "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface: \"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId: \"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"response of 200\"\n schema:\n type: \"string\"\n"
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功。 |
|
400 |
错误的请求。 |
|
500 |
服务内部错误。 |
错误码
请参见错误码。
