获取服务契约定义列表

请求参数

Query 参数

id

string

服务契约定义ID

可选

namespace

string

命名空间

可选

service

string

服务名称

可选

name

string

可选

服务契约名称，如果需要查询多个，名称之间英文逗号风格

protocol

string

可选

服务契约协议，http/grpc/dubbo/thrift

version

string

服务契约版本

可选

brief

string

可选

是否只展示简单信息，字符串 true/false

offset

integer

可选

分页偏移量，默认为0

示例值:

0

limit

integer

可选

分页条数，最大为 100

示例值:

100

Header 参数

X-Polaris-Token

string

可选

鉴权凭据，当OpenAPI接口鉴权开启时必须开启

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://119.91.66.223:8090/naming/v1/service/contracts?id=&namespace=&service=&name=&protocol=&version=&brief=&offset=0&limit=100' \
--header 'X-Polaris-Token;'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

可选

info

string

提示信息

可选

data

array [object {13}]

必需

id

string

服务契约ID

必需

type

string

服务契约类型

必需

namespace

string

命名空间

必需

service

string

服务名

必需

protocol

string

协议

必需

http/dubbo/grpc/thrift

version

string

协议版本

必需

revision

string

服务契约摘要

必需

content

string

内容正文

必需

contentDigest

string

内容摘要

必需

status

string

在线状态

必需

1、Online 在线；2、Offline 离线

interfaces

$ref(#/definitions/159468124)[]

接口列表

必需

如果查询设置了 brief=false, 则会展示 interface 列表

ctime

string

创建时间

必需

格式：2006-01-02 15:04:05

mtime

string

更新时间

必需

格式：2006-01-02 15:04:05

amount

integer

总数

必需

size

integer

当前返回的数据条数

必需

示例