查询服务 - 云原生网关

请求参数

Authorization

Query 参数

string

服务-内部id

必需

instId

string

实例Id

必需

Header 参数

jwt

string

可选

默认值:

eyJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOjE4MjA3NCwidGVuYW50SWQiOjk5NDg3MDcsInVzZXJOYW1lIjoiY3R5dW4wYTFjMzI1MmI2MjQ0NzEyMTcyNTQyMjU3MSIsInRlbmFudE5hbWUiOiJtc2FwX21zZV9jc21fZGV2X21hc3RlckBxcS5jb20jcGFhczQwIiwidGVuYW50Q29kZSI6IkN0eXVuM2UxNjIxYTY3YjQwNDY0MjE3MjU0MjI1NzEiLCJidXNpVXNlcklkIjpudWxsLCJidXNpVGVuYW50SWQiOm51bGwsImJ1c2lUZW5hbnROYW1lIjpudWxsLCJhY2NvdW50VHlwZSI6MCwiaXNPd25lciI6dHJ1ZSwicmVhbE5hbWUiOiJtc2FwX21zZV9jc21fZGV2IiwicmVxU291cmNlIjoiMDEiLCJ2ZXJzaW9uTm8iOiIzLjAuMCIsInJlc1Bvb2xDb2RlIjoiYjM0MmI3N2VmMjZiMTFlY2IwYWMwMjQyYWMxMTAwMDIiLCJwcml2YXRlS2V5IjpudWxsLCJvdXRlclRlbmFudElkIjoiM2UxNjIxYTY3YjQwNDY0MmIxMDAxMDc3YzcxYmE3OWYiLCJvdXRlclVzZXJJZCI6IjBhMWMzMjUyYjYyNDQ3MTJiNmNiM2FhMGU1YTc5M2JmIiwiYWdlbnRVc2VySWQiOm51bGwsImFnZW50VGVuYW50SWQiOm51bGwsImlhdCI6MTczMjUxOTQ3NCwiaXNzIjoiZmlyc3R6dXVsIiwiZXhwIjoyMzMyNTE5NDc0fQ.XiXnJQmUSVc8I-IVY99JE5VmHMvM8dydDpD9xC5St8g

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

*/*

Body

code

integer <int32>

响应编码

可选

示例值:

200

data

object (UpstreamDTO)

服务

可选

balancerStrategy

object (BalancerStrategyDTO)

服务负载均衡配置

可选

certFileName

string

证书文件名

可选

certKeyFileName

string

密钥证书文件名

可选

code

string

服务-内部资源ID

可选

createTime

string <date-time>

创建时间

可选

dnsService

object (DnsUpstreamDTO)

可选

enableMtls

boolean

是否开启双向认证

可选

faasService

object (FaasServiceDTO)

可选

groupName

string

组名

可选

healthCheckConfig

object (HealthCheckConfigDTO)

可选

label

object

标签map

可选

labelNames

array[object (LabelNameDTO) {2}]

标签名列表

可选

name

string

服务名称

可选

namespace

string

可选

命名空间，来源为Nacos时值为命名空间ID

nodes

array[object (VipServiceNodeDTO) {4}]

固定地址节点列表

可选

protocol

string

服务协议

可选

resourceCreator

string

可选

类型，取值：control或Ingress

resourceCreatorDesc

string

可选

类型，取值：管控或Ingress

retry

object (Retry)

可选

serviceNameInRegistry

string

注册中心服务名

可选

serviceType

string

可选

服务类型，取值：general普通服务或Dubbo服务

sourceType

string

可选

服务来源，VIP：固定地址；NACOS：nacos来源；KUBERNETES：k8s来源；FAAS：函数计算；DNS：DNS域名

timeout

object (TimeoutApisixDTO)

可选

updateTime

string <date-time>

更新时间

可选

message

string

消息内容

可选

示例值:

success

requestId

string

请求唯一id

可选

示例值:

123456789-adc

示例

{
    "code": 200,
    "data": {
        "balancerStrategy": {
            "balancerType": "roundrobin",
            "hashOn": "vars",
            "key": "uri"
        },
        "certFileName": "string",
        "certKeyFileName": "string",
        "code": "string",
        "createTime": "2019-08-24T14:15:22Z",
        "dnsService": {
            "serviceDomain": "string",
            "servicePort": 0
        },
        "enableMtls": true,
        "faasService": {
            "aliasName": "string",
            "functionId": "string",
            "functionName": "string",
            "host": "string",
            "versionId": "string",
            "vpceClientAddress": "string"
        },
        "groupName": "string",
        "healthCheckConfig": {
            "active": {
                "concurrency": 0,
                "enable": false,
                "healthy": {
                    "httpStatuses": [
                        200,
                        302
                    ],
                    "interval": 1,
                    "successes": 2
                },
                "httpPath": "/",
                "httpsVerifyCertificate": true,
                "port": "${upstream.node.port}",
                "reqHeaders": [],
                "timeout": 0,
                "type": "http",
                "unhealthy": {
                    "httpFailures": 5,
                    "httpStatuses": [
                        429,
                        404,
                        500,
                        501,
                        502,
                        503,
                        504,
                        505
                    ],
                    "interval": "7a2828074ef6e32e041a2ef124b19e63",
                    "tcpFailures": 2,
                    "timeouts": 3
                }
            },
            "forceEnableChecks": false,
            "passive": {
                "enable": false,
                "healthy": {
                    "httpStatuses": [
                        200
                    ],
                    "successes": 5
                },
                "type": "http",
                "unhealthy": {
                    "httpFailures": 0,
                    "httpStatuses": [
                        0
                    ],
                    "tcpFailures": 0,
                    "timeouts": 0
                }
            }
        },
        "label": {
            "property1": [
                {
                    "labelValue": "string",
                    "labelValueVO": "string"
                }
            ],
            "property2": [
                {
                    "labelValue": "string",
                    "labelValueVO": "string"
                }
            ]
        },
        "labelNames": [
            {
                "labelName": "string",
                "labelNameVO": "string"
            }
        ],
        "name": "string",
        "namespace": "string",
        "nodes": [
            {
                "host": "string",
                "port": 0,
                "priority": 0,
                "weight": 0
            }
        ],
        "protocol": "string",
        "resourceCreator": "string",
        "resourceCreatorDesc": "string",
        "retry": {
            "retries": 0,
            "retryTimeout": 0
        },
        "serviceNameInRegistry": "string",
        "serviceType": "string",
        "sourceType": "string",
        "timeout": {
            "connect": 0,
            "read": 0,
            "send": 0
        },
        "updateTime": "2019-08-24T14:15:22Z"
    },
    "message": "success",
    "requestId": "123456789-adc"
}

🟠401没有权限

🟠403禁止访问

🟠404记录不存在