PolarisMesh
  1. 服务契约
PolarisMesh
PolarisMesh
  • PolarisMesh
  • 命名空间
    • 批量创建命名空间
      POST
    • 批量更新命名空间
      PUT
    • 批量删除命名空间
      POST
    • 获取命名空间列表
      GET
  • 注册发现
    • 服务
      • 批量创建服务
      • 批量删除服务
      • 获取服务列表
      • 批量更新服务
      • 获取全部的服务名称列表
      • 创建服务别名
      • 更新服务别名
      • 批量删除服务别名
      • 获取服务别名列表
    • 服务实例
      • 批量创建服务实例
      • 批量更新服务实例
      • 批量删除服务实例
      • 根据IP批量删除服务实例
      • 根据IP批量隔离服务实例
      • 获取服务实例列表
      • 获取某个服务下的所有实例标签
      • 获取当前北极星集群下的所有服务实例总数
      • 获取多个服务下的所有实例标签
    • 服务契约
      • 批量创建服务契约定义
      • 获取服务契约定义列表
      • 获取服务契约定义版本列表
      • 批量删除服务契约定义
      • 覆盖创建某个服务契约下的接口列表信息数据
      • 覆盖追加某个服务契约下的接口列表信息数据
      • 删除某个服务契约下的部份接口列表信息数据
      • 获取服务接口列表
  • 服务治理
    • 路由规则
      • 批量创建路由规则
      • 批量更新路由规则
      • 批量启用/禁用路由规则
      • 批量删除路由规则
      • 查询路由规则
      • 导出路由规则
      • 导入路由规则
    • 限流规则
      • 批量创建限流规则
      • 批量更新限流规则
      • 批量启用/禁用限流规则
      • 批量删除限流规则
      • 获取限流规则列表
      • 导出限流规则列表
      • 导入限流规则列表
    • 熔断规则
      • 批量创建熔断规则
      • 批量更新熔断规则
      • 批量启用/禁用熔断规则
      • 批量删除熔断规则
      • 获取熔断规则列表
      • 导出熔断规则
      • 导入熔断规则
    • 探测规则
      • 批量创建主动探测规则
      • 批量更新主动探测规则
      • 批量删除主动探测规则
      • 获取主动探测规则列表
    • 泳道规则
      • 批量创建泳道组
      • 批量更新泳道组
      • 批量删除泳道组
      • 查询泳道组列表
  • 配置中心
    • 配置分组
      • 创建配置分组
      • 更新配置分组
      • 删除配置分组
      • 获取配置分组列表
    • 配置文件
      • 创建配置文件
      • 更新配置文件
      • 删除配置文件
      • 批量删除配置文件
      • 创建/更新配置文件并发布
      • 查询某个配置分组下的所有配置文件
      • 查询配置文件列表
      • 导出配置文件
      • 导入配置文件
      • 查询单个配置文件
    • 配置发布
      • 配置发布
      • 获取配置发布版本列表
      • 获取某个配置文件的发布版本列表
      • 回滚配置到某次发布
      • 删除某个配置发布
      • 获取某个发布的具体详细信息
      • 停止某个配置灰度发布
    • 配置历史
      • 获取配置发布历史
  • 用户/鉴权
    • 用户
      • 修改用户密码
      • 批量创建用户
      • 更新用户
      • 获取用户列表
      • 登陆
      • 启用/禁用用户资源访问Token
      • 重置用户资源访问Token
      • 获取用户Token
      • 批量删除用户
    • 用户组
      • 创建用户组
      • 删除用户组中的用户
      • 获取用户组列表
      • 获取用户组详细
      • 获取用户组资源访问Token
      • 重置用户组资源访问Token
      • 启用/禁用用户组资源访问Token
      • 更新用户组
    • 鉴权策略
      • 创建鉴权策略
      • 更新鉴权策略
      • 删除鉴权策略
      • 获取策略列表
      • 获取用户/用户组可操作资源列表
      • 获取鉴权策略详细
    • 角色
      • 批量创建角色
      • 批量更新角色
      • 批量删除角色
      • 查询角色列表
  • SDK接口
    • 服务治理
      • 注册服务实例
      • 反注册服务实例
      • 实例心跳上报
      • 获取服务列表
      • 获取服务实例列表
      • 获取限流规则
      • 获取熔断规则
      • 获取自定义路由规则
      • 获取就近路由规则
      • 获取主动探测规则
      • 获取服务契约信息
    • 配置中心
      • 获取客户端可见的发布
      • 客户端监听配置文件
      • 获取配置分组下已发布的配置文件名称列表
  • 运维管理
    • 获取日志输出级别
    • 设置日志输出级别
    • 获取存储层Leader列表
    • 获取CMDB插件信息
    • 获取所有北极星SDK实例信息
    • 获取实例的最后一次心跳数据
    • 查询服务端的接口列表名称信息
  • 历史-v1.18.x
    • 命名空间
      • 批量创建命名空间
      • 批量更新命名空间
      • 批量删除命名空间
      • 获取命名空间列表
    • 注册发现
      • 服务
        • 获取全部的服务名称列表
        • 创建服务别名
        • 更新服务别名
        • 批量删除服务别名
        • 获取服务别名列表
        • 批量创建服务
        • 批量删除服务
        • 获取服务列表
        • 批量更新服务
      • 服务实例
        • 批量创建服务实例
        • 批量更新服务实例
        • 批量删除服务实例
        • 根据IP批量删除服务实例
        • 根据IP批量隔离服务实例
        • 获取服务实例列表
        • 获取某个服务下的所有实例标签
        • 获取当前北极星集群下的所有服务实例总数
        • 获取多个服务下的所有实例标签
      • 服务契约
        • 批量创建服务契约定义
          POST
        • 获取服务契约定义列表
          GET
        • 获取服务契约定义版本列表
          GET
        • 批量删除服务契约定义
          POST
        • 覆盖创建某个服务契约下的接口列表信息数据
          POST
        • 覆盖追加某个服务契约下的接口列表信息数据
          PUT
        • 删除某个服务契约下的部份接口列表信息数据
          POST
        • 获取服务接口列表
          GET
    • 服务治理
      • 路由规则
        • 批量创建路由规则
        • 批量更新路由规则
        • 批量启用/禁用路由规则
        • 批量删除路由规则
        • 查询路由规则
        • 导出路由规则
        • 导入路由规则
      • 限流规则
        • 批量创建限流规则
        • 批量更新限流规则
        • 批量启用/禁用限流规则
        • 批量删除限流规则
        • 获取限流规则列表
        • 导出限流规则列表
        • 导入限流规则列表
      • 熔断规则
        • 批量创建熔断规则
        • 批量更新熔断规则
        • 批量启用/禁用熔断规则
        • 批量删除熔断规则
        • 获取熔断规则列表
        • 导出熔断规则
        • 导入熔断规则
      • 探测规则
        • 批量创建主动探测规则
        • 批量更新主动探测规则
        • 批量删除主动探测规则
        • 获取主动探测规则列表
      • 泳道规则
        • 批量创建泳道组
        • 批量更新泳道组
        • 批量删除泳道组
        • 查询泳道组列表
    • 配置中心
      • 配置分组
        • 创建配置分组
        • 更新配置分组
        • 删除配置分组
        • 获取配置分组列表
      • 配置文件
        • 创建配置文件
        • 更新配置文件
        • 删除配置文件
        • 批量删除配置文件
        • 创建/更新配置文件并发布
        • 查询某个配置分组下的所有配置文件
        • 查询配置文件列表
        • 导出配置文件
        • 导入配置文件
        • 查询单个配置文件
      • 配置发布
        • 配置发布
        • 更新配置发布
        • 获取配置发布版本列表
        • 获取某个配置文件的发布版本列表
        • 回滚配置到某次发布
        • 删除某个配置发布
        • 获取某个发布的具体详细信息
        • 停止某个配置灰度发布
      • 配置历史
        • 获取配置发布历史
    • 用户/鉴权
      • 用户
        • 修改用户密码
        • 批量创建用户
        • 更新用户
        • 获取用户列表
        • 登陆
        • 启用/禁用用户资源访问Token
        • 重置用户资源访问Token
        • 获取用户Token
        • 批量删除用户
      • 用户组
        • 创建用户组
        • 删除用户组中的用户
        • 获取用户组列表
        • 获取用户组详细
        • 获取用户组资源访问Token
        • 重置用户组资源访问Token
        • 启用/禁用用户组资源访问Token
        • 更新用户组
      • 鉴权策略
        • 创建鉴权策略
        • 更新鉴权策略
        • 删除鉴权策略
        • 获取策略列表
        • 获取用户/用户组可操作资源列表
        • 获取鉴权策略详细
    • SDK接口
      • 服务治理
        • 注册服务实例
        • 反注册服务实例
        • 实例心跳上报
        • SDK接口-服务列表获取
        • SDK接口-服务实例获取
        • SDK接口-限流规则获取
        • SDK接口-熔断规则获取
        • SDK接口-自定义路由规则获取
        • SDK接口-就近路由规则获取
        • SDK接口-主动探测规则获取
        • 获取服务契约信息
      • 配置中心
        • 获取客户端可见的发布
        • 客户端监听配置文件
        • 获取配置分组下已发布的配置文件名称列表
    • 运维管理
      • 获取日志输出级别
      • 设置日志输出级别
      • 获取存储层Leader列表
      • 获取CMDB插件信息
      • 获取所有北极星SDK实例信息
      • 获取实例的最后一次心跳数据
  • 历史-v1.17.x
    • 命名空间
      • 批量创建命名空间
      • 批量更新命名空间
      • 批量删除命名空间
      • 获取命名空间列表
    • 注册发现
      • 服务
        • 获取全部的服务名称列表
        • 创建服务别名
        • 更新服务别名
        • 批量删除服务别名
        • 获取服务别名列表
        • 批量创建服务
        • 批量删除服务
        • 获取服务列表
        • 批量更新服务
      • 服务实例
        • 批量创建服务实例
        • 批量更新服务实例
        • 批量删除服务实例
        • 根据IP批量删除服务实例
        • 根据IP批量隔离服务实例
        • 获取服务实例列表
        • 获取某个服务下的所有实例标签
        • 获取当前北极星集群下的所有服务实例总数
        • 获取多个服务下的所有实例标签
      • 服务契约
        • 批量创建服务契约定义
        • 获取服务契约定义列表
        • 获取服务契约定义版本列表
        • 批量删除服务契约定义
        • 覆盖创建某个服务契约下的接口列表信息数据
        • 覆盖追加某个服务契约下的接口列表信息数据
        • 删除某个服务契约下的部份接口列表信息数据
        • 获取服务接口列表
    • 服务治理
      • 路由规则
        • 批量创建路由规则
        • 批量更新路由规则
        • 批量启用/禁用路由规则
        • 批量删除路由规则
        • 查询路由规则
        • 导出路由规则
        • 导入路由规则
      • 限流规则
        • 批量创建限流规则
        • 批量更新限流规则
        • 批量启用/禁用限流规则
        • 批量删除限流规则
        • 获取限流规则列表
        • 导出限流规则列表
        • 导入限流规则列表
      • 熔断规则
        • 批量创建熔断规则
        • 批量更新熔断规则
        • 批量启用/禁用熔断规则
        • 批量删除熔断规则
        • 获取熔断规则列表
        • 导出熔断规则
        • 导入熔断规则
      • 探测规则
        • 批量创建主动探测规则
        • 批量更新主动探测规则
        • 批量删除主动探测规则
        • 获取主动探测规则列表
      • 泳道规则
        • 批量创建泳道组
        • 批量更新泳道组
        • 批量删除泳道组
        • 查询泳道组列表
    • 配置中心
      • 配置分组
        • 创建配置分组
        • 更新配置分组
        • 删除配置分组
        • 获取配置分组列表
      • 配置文件
        • 创建配置文件
        • 更新配置文件
        • 删除配置文件
        • 批量删除配置文件
        • 创建/更新配置文件并发布
        • 查询某个配置分组下的所有配置文件
        • 查询配置文件列表
        • 导出配置文件
        • 导入配置文件
        • 查询单个配置文件
      • 配置发布
        • 配置发布
        • 更新配置发布
        • 获取配置发布版本列表
        • 获取某个配置文件的发布版本列表
        • 回滚配置到某次发布
        • 删除某个配置发布
        • 获取某个发布的具体详细信息
        • 停止某个配置灰度发布
      • 配置历史
        • 获取配置发布历史
    • 用户/鉴权
      • 用户
        • 修改用户密码
        • 批量创建用户
        • 更新用户
        • 获取用户列表
        • 登陆
        • 启用/禁用用户资源访问Token
        • 重置用户资源访问Token
        • 获取用户Token
        • 批量删除用户
      • 用户组
        • 创建用户组
        • 删除用户组中的用户
        • 获取用户组列表
        • 获取用户组详细
        • 获取用户组资源访问Token
        • 重置用户组资源访问Token
        • 启用/禁用用户组资源访问Token
        • 更新用户组
      • 鉴权策略
        • 创建鉴权策略
        • 更新鉴权策略
        • 删除鉴权策略
        • 获取策略列表
        • 获取用户/用户组可操作资源列表
        • 获取鉴权策略详细
    • SDK接口
      • 服务治理
        • 注册服务实例
        • 反注册服务实例
        • 实例心跳上报
        • SDK接口-服务列表获取
        • SDK接口-服务实例获取
        • SDK接口-限流规则获取
        • SDK接口-熔断规则获取
        • SDK接口-自定义路由规则获取
        • SDK接口-就近路由规则获取
        • SDK接口-主动探测规则获取
        • 获取服务契约信息
      • 配置中心
        • 获取客户端可见的发布
        • 客户端监听配置文件
        • 获取配置分组下已发布的配置文件名称列表
    • 运维管理
      • 获取日志输出级别
      • 设置日志输出级别
      • 获取存储层Leader列表
      • 获取CMDB插件信息
      • 获取所有北极星SDK实例信息
      • 获取实例的最后一次心跳数据
  1. 服务契约

获取服务接口列表

开发中
GET
/naming/v1/service/contract/methods
最后修改时间:2024-08-21 04:18:22
责任人:未设置
从 1.18.1 开始可用

请求参数

Query 参数
id
string 
接口ID
可选
namespace
string 
命名空间
可选
service
string 
服务名称
可选
type
string 
类型
可选
protocol
string 
可选
服务契约协议,http/grpc/dubbo/thrift
version
string 
服务契约版本
可选
method
string 
接口方法
可选
path
string 
接口路径
可选
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
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://119.91.66.223:8090/naming/v1/service/contract/methods?id=&namespace=&service=&type=&protocol=&version=&method&path&offset=0&limit=100' \
--header 'X-Polaris-Token;'

返回响应

🟢200成功
application/json
Body
code
integer 
状态码
可选
info
string 
提示信息
可选
data
array[object (服务契约接口定义) {14}] 
必需
id
string 
接口描述ID
可选
method
string 
方法
必需
path
string 
路径
必需
content
string 
接口内容正文
必需
包含方法入参、出参、header等信息
根据 protocol 保存各自特殊的内容
contentDigest
string 
接口内容摘要
必需
source
string 
创建来源
必需
手动创建 or 客户端上报
revision
string 
内容摘要
必需
ctime
string 
创建时间
必需
格式:2006-01-02 15:04:05
mtime
string 
更新时间
必需
格式:2006-01-02 15:04:05
namespace
string 
必需
service
string 
必需
protocol
string 
必需
version
string 
必需
type
string 
必需
amount
integer 
总数
必需
size
integer 
当前返回的数据条数
必需
示例
{
    "code": 0,
    "info": "string",
    "data": [
        {
            "id": "string",
            "method": "string",
            "path": "string",
            "content": "string",
            "contentDigest": "string",
            "source": "string",
            "revision": "string",
            "ctime": "string",
            "mtime": "string",
            "namespace": "string",
            "service": "string",
            "protocol": "string",
            "version": "string",
            "type": "string"
        }
    ],
    "amount": 0,
    "size": 0
}
修改于 2024-08-21 04:18:22
上一页
删除某个服务契约下的部份接口列表信息数据
下一页
批量创建路由规则
Built with