文档首页 > > API参考> CSE API> 契约> 查询微服务的所有契约

查询微服务的所有契约

分享
更新时间: 2020/06/24 GMT+08:00

功能介绍

查询一个微服务的所有契约信息,包括schema_id和summary信息。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

service_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

withSchema

Integer

是否查询schema内容。包括:0表示不显示schema内容只有schema_id和summary。1表示显示schema_id、summary和schema。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-domain-name

String

租户账号名称。

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

schemas

Array of Schema objects

契约列表。

表5 Schema

参数

参数类型

描述

schemaId

String

微服务契约ID。支持数字、字母和括号内字符(_-.),长度1-160字节。

schema

String

微服务契约内容。任意字符、长度1-2048字节。

summary

String

微服务契约摘要。支持数字、字母,长度0-128字节。

状态码为 400 时:

表6 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

状态码为 500 时:

表7 响应Body参数

参数

参数类型

描述

errorCode

String

错误代码。

errorMessage

String

错误信息。

detail

String

详细定位信息。

请求示例

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

""

响应示例

状态码为 200 时:

{
  "schemas" : [ {
    "schemaId" : "string",
    "schema" : "string",
    "summary" : "string"
  } ]
}

状态码为 400 时:

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码为 500 时:

{
  "errorCode" : "string",
  "errorMessage" : "string",
  "detail" : "string"
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问