获取服务列表 - PolarisMesh

请求参数

Query 参数

name

string

可选

服务名称，如果需要前缀匹配，则为 name，如果是后缀匹配，则为 name

namespace

string

可选

命名空间，如果需要前缀匹配，则为 namespace，如果是后缀匹配，则为 namespace

business

string

可选

业务信息，只能精确匹配

department

string

可选

部门信息，只能精确匹配

keys

string

可选

服务元数据名，keys和values需要同时填写，目前只支持查询一组元数据。

values

string

可选

服务元数据值，keys和values需要同时填写，目前只支持查询一组元数据。

instance_keys

string

可选

实例标签key, key-1,key-2, instance_keys 和 instance_values 需要同时填写且必须元素个数一致

instance_values

string

可选

实例标签value, value-1,value-2, instance_keys 和 instance_values 需要同时填写且必须元素个数一致

offset

integer

可选

分页偏移量，默认为0

示例值:

0

limit

integer

可选

分页条数，最大为 100

示例值:

100

host

string

可选

实例IP，多个IP以英文逗号分隔

port

string

可选

实例端口，多个端口以英文逗号分隔

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/services?name=&namespace=&business=&department=&keys=&values=&instance_keys=&instance_values=&offset=0&limit=100&host=&port=' \
--header 'X-Polaris-Token;'

返回响应

🟢200成功

application/json

Body

amount

integer

总数

必需

code

integer

响应码

必需

info

string

提示信息

必需

services

array [object {10}]

服务列表

必需

id

string

服务id

可选

name

string

服务名称

必需

namespace

string

服务所在命名空间

必需

business

string

业务信息

可选

department

string

部门信息

可选

comment

string

服务描述

可选

metadata

object

服务标签

可选

ports

string

服务的端口列表

可选

export_to

array[string]

设置服务对其他命名空间的可见性, 从 1.18.0 开始可用

可选

不对别的命名空间可见，不设置

仅对部份命名空间可见，填写相应命名空间名称

对全部命名空间可见，固定填写 * 字符

sync_to_global_registry

boolean

同步全局注册中心

可选

对服务关联的资源开启多注册中心同步的能力

size

integer

当前返回数据总数

必需

示例

{
  "amount": 0,
  "code": 0,
  "info": "string",
  "services": [
    {
      "id": "string",
      "name": "string",
      "namespace": "string",
      "business": "string",
      "department": "string",
      "comment": "string",
      "metadata": {},
      "ports": "string",
      "export_to": [
        "string"
      ],
      "sync_to_global_registry": true
    }
  ],
  "size": 0
}