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

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

查询微服务的所有契约

功能介绍

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

调试

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

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

租户帐号名称。

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

schemas

Array of Schema objects

契约列表。

表5 Schema

参数

参数类型

描述

schemaId

String

契约id

状态码: 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"
  } ]
}

状态码

状态码

描述

200

查询成功。

400

错误的请求。

500

服务内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品