获取服务实例列表

请求参数

Query 参数

id

string

实例ID

可选

service

string

可选

service namespace host 三个必须最少传一个, 前缀查询: name*; 后缀查询: *name; 全模糊查询: name

namespace

string

可选

service namespace host 三个必须最少传一个, 前缀查询: name*; 后缀查询: *name; 全模糊查询: name

host

string

可选

service namespace host 三个必须最少传一个

keys

string

标签 key

可选

values

string

标签 value

可选

healthy

string

实例健康状态

可选

isolate

string

实例隔离状态

可选

protocol

string

实例端口协议

可选

version

string

实例版本

可选

offset

integer

可选

分页偏移量，默认为0

示例值:

0

limit

integer

可选

分页条数，最大为 100

示例值:

100

show_last_heartbeat

string

可选

是否显示实例的最后一次心跳时间，从1.18.1开始支持

show_service_revision

string

可选

是否显示每个服务的当前实例列表的revision信息，从1.18.1开始支持

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/instances?id&service&namespace&host&keys&values&healthy&isolate&protocol&version&offset=0&limit=100&show_last_heartbeat&show_service_revision' \
--header 'X-Polaris-Token;'

返回响应

🟢200成功

application/json

Body

amount

integer

总数

必需

code

integer

响应码

必需

info

string

提示信息

必需

instances

array [object {18}]

实例列表

必需

id

string

实例ID

可选

service

string

服务名称

可选

namespace

string

命名空间

可选

host

string

实例host

可选

port

integer

实例端口

可选

healthy

boolean

健康状态

可选

isolate

boolean

隔离状态

可选

location

object

实例地理信息

可选

metadata

object

实例标签

可选

enableHealthCheck

boolean

是否开启健康检查

可选

healthCheck

object

健康检查类型

可选

priority

integer

实例优先级

可选

protocol

string

实例协议

可选

revision

string

实例摘要

可选

version

string

实例版本

可选

weight

integer

实例权重

可选

ctime

string

创建时间

可选

mtime

string

更新时间

可选

size

integer

返回实例总数

必需

示例

{
    "amount": 0,
    "code": 0,
    "info": "string",
    "instances": [
        {
            "id": "string",
            "service": "string",
            "namespace": "string",
            "host": "string",
            "port": 0,
            "healthy": true,
            "isolate": true,
            "location": {
                "campus": "string",
                "region": "string",
                "zone": "string"
            },
            "metadata": {
                "additionalProp1": "string",
                "additionalProp2": "string",
                "additionalProp3": "string"
            },
            "enableHealthCheck": true,
            "healthCheck": {
                "heartbeat": {
                    "ttl": 0
                },
                "type": 0
            },
            "priority": 0,
            "protocol": "string",
            "revision": "string",
            "version": "string",
            "weight": 0,
            "ctime": "string",
            "mtime": "string"
        }
    ],
    "size": 0
}