文档首页/ 应用管理与运维平台 ServiceStage/ API参考（吉隆坡区域）/ CSE API/ 查询微服务的所有契约
更新时间：2023-06-26 GMT+08:00
查看PDF
分享

查询微服务的所有契约

功能介绍

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

URI

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

表1 路径参数

参数

类型

必选

说明

project_id

String

是

请填固定值：default。

serviceId

String

是

微服务唯一标识。

字符长度为1~64。

正则表达式为^.*$
表2 Query参数

参数

类型

必选

说明

withSchema

String

否
是否查询schema内容，默认为0。包括：
  • 0表示不显示schema内容只有schemaId和summary。
  • 1表示显示schemaId、summary和schema。

请求消息

请求参数

无

响应消息

响应参数

参数说明请参见表3。

表3 参数说明

参数

类型

说明

schemas

Array of objects

成功获取微服务所有schema结构体的列表，具体参考Schema。

示例

请求示例

无

响应示例

{
    "schemas": [
        {
            "schemaId": "xxxx",
            "schema": "xxxx", // 当url带withSchema=1参数才返回，默认不返回
            "summary": "abcd"
        }
    ]
}

状态码

状态码请参见状态码。

错误码

错误码请参见CSE错误码。

父主题： CSE API