调用GetServiceListPage接口获取服务列表。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST|GET /pop/sp/api/mseForOam/getServiceListPage HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
region String Query cn-hangzhou

地域。

namespace String Query cn-hangzhou:doc-test

命名空间。

origin String Query Agent

数据来源,取值如下:

  • agent:新版服务查询需要传递。
  • registry:旧版服务查询传递。
serviceType String Query SpringCloud

服务类型,取值如下:

  • dubbo
  • springCloud
  • hsf
  • istio
searchType String Query App

服务类型,取值如下:

  • app:应用维度查询。
  • service:服务维度查询。
  • providerIp:IP维度查询。
searchValue String Query com.alibaba.edas.HelloService

搜索关键字:

  • 如果searchType=app,searchValue填写appId
  • 如果serachType=service,searchValue填写serviceName
  • 如果searchType=providerIp,searchValue填写应用IP地址。
side String Query provider

提供者侧或者消费者侧,取值如下:

  • provider
  • consumer
page Integer Query 0

列表的页码,从0开始。

size Integer Query 10

分页查询时每页的行数。

返回数据

名称 类型 示例值 描述
Code Integer 200

接口状态或POP错误码。

Message String success

接口请求返回的信息。

Success Boolean true

调用是否成功。

Data Object

数据。

TotalPages Integer 1

总页数。

TotalElements Integer 6

总数据量。

Size Integer 8

页大小。

Content Array of MseServiceResponse

组数据。

EdasAppName String k8s-lq-cartservice

应用名。

InstanceNum Integer 1

实例数量。

Version String 1.0.0

版本号。

ServiceId String xx

服务ID。

EdasAppId String efbda488-7b33-432f-****-36530047****

应用ID。

ServiceName String com.alibabacloud.hipstershop.CartService

服务名。

RegisterType String xx

注册类型。

Group String DUBBO

分组。

示例

请求示例

POST /pop/sp/api/mseForOam/getServiceListPage HTTP/1.1
公共请求头

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetServiceListPageResponse>
    <Code>200</Code>
    <Message>success</Message>
    <Success>true</Success>
    <Data>
        <TotalPages>1</TotalPages>
        <TotalElements>6</TotalElements>
        <Size>8</Size>
        <Content>
            <EdasAppName>k8s-lq-cartservice</EdasAppName>
            <InstanceNum>1</InstanceNum>
            <Version>1.0.0</Version>
            <ServiceId>xx</ServiceId>
            <EdasAppId>efbda488-7b33-432f-****-36530047****</EdasAppId>
            <ServiceName>com.alibabacloud.hipstershop.CartService</ServiceName>
            <RegisterType>xx</RegisterType>
            <Group>DUBBO</Group>
        </Content>
    </Data>
</GetServiceListPageResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Code" : 200,
  "Message" : "success",
  "Success" : true,
  "Data" : {
    "TotalPages" : 1,
    "TotalElements" : 6,
    "Size" : 8,
    "Content" : {
      "EdasAppName" : "k8s-lq-cartservice",
      "InstanceNum" : 1,
      "Version" : "1.0.0",
      "ServiceId" : "xx",
      "EdasAppId" : "efbda488-7b33-432f-****-36530047****",
      "ServiceName" : "com.alibabacloud.hipstershop.CartService",
      "RegisterType" : "xx",
      "Group" : "DUBBO"
    }
  }
}