全部产品
Search
文档中心

服务网格 ASM:GetRegisteredServiceEndpoints - 获取注册到网格内的服务端点信息

更新时间:Mar 05, 2024

调用GetRegisteredServiceEndpoints获取注册服务端点信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

服务网格实例 ID

c08ba3fd1e6484b0f8cc1ad8fe10d****
Namespacestring

命名空间

default
ClusterIdsstring

集群 ID 列表,用逗号分隔

c8b054ee8c3914d079b5ce9733328****,c58faedb8a78640d3aeb0372e4c02****
Namestring

服务名称

reviews
ServiceTypestring

服务类型,取值:

  • ServiceEntry:为服务网格 ServiceEntry 中注册的服务

  • Kubernetes:为数据面 Kubernetes 集群注册的服务

Kubernetes

返回参数

名称类型描述示例值
object

响应体

ServiceEndpointsobject []

服务端点信息列表

Addressstring

服务地址

192.168.25.153
ClusterIdstring

数据面集群 ID

c80f45444b3da447da60a911390c2****
EndPointSliceobject

服务端点详细信息列表

ServiceNamestring

服务名称

reviews
Namespacestring

命名空间

default
Locationstring

服务所在的位置。可选参数:

  • MESH_INTERNAL:服务在网格内部

  • MESH_EXTERNAL:服务在网格外部

MESH_INTERNAL
EndpointsDetailsobject []

服务端点详细信息列表

PodNamestring

pod 名称

provider-v1-8c86b6898-h***
Addressstring

服务端点地址

127.2.**.**
Portsarray

端口列表

integer

服务端口

9090
Hostnamestring

服务地址

www.demo.com
Regionstring

地域 ID

cn-hangzhou
SidecarInjectedboolean

是否注入 Sidecar 代理,取值:

  • true:注入 Sidecar 代理

  • false:不注入 Sidecar 代理

false
RequestIdstring

请求 ID

31d3a0f0-07ed-4f6e-9004-1804498c****

示例

正常返回示例

JSON格式

{
  "ServiceEndpoints": [
    {
      "Address": "192.168.25.153",
      "ClusterId": "c80f45444b3da447da60a911390c2****"
    }
  ],
  "EndPointSlice": {
    "ServiceName": "reviews",
    "Namespace": "default",
    "Location": "MESH_INTERNAL",
    "EndpointsDetails": [
      {
        "PodName": "provider-v1-8c86b6898-h***",
        "Address": "127.2.**.**",
        "Ports": [
          9090
        ],
        "Hostname": "www.demo.com",
        "Region": "cn-hangzhou",
        "SidecarInjected": false
      }
    ]
  },
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

错误码

HTTP status code错误码错误信息描述
500ERR500An internal server error occurred.后端服务异常

访问错误中心查看更多错误码。