调用ListAppServicesPage接口获取应用服务列表。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头

请求语法

GET /pop/v1/sam/service/listAppServicesPage HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
AppId String Query 6dcc8c9e-d3da-478a-a066-86dcf820****

应用ID。

ServiceType String Query springCloud

服务类型。取值说明如下:

  • dubbo
  • springCloud
PageNumber Integer Query 1

列表页码。

PageSize Integer Query 9999

页码大小。取值范围[0, 9999]。

返回数据

名称 类型 示例值 描述
RequestId String 2583E089-99C2-562E-8B7E-73512136****

请求ID。

Message String success

调用结果的附加信息。

TraceId String 0be3e0c816394483660457498e****

调用链ID,用于精确查询调用信息。

Data Array of Data

服务列表信息。

CurrentPage String 1

当前页数。

TotalSize String 1

页码总数。

PageNumber String 1

列表页码。

PageSize String 9999

页码大小。取值范围[0, 9999]。

Result Array of MscAgentServiceResponse

返回结果。

EdasAppName String cn-zhangjiakou-micro-service-******

应用名称。

Version String 1.0.0

服务版本。自定义。

InstanceNum Long 1

实例数量。

EdasAppId String hc4fs1****@98314c8790b****

应用ID。

ServiceName String edas.service.provider

服务名称。

Group String springCloud

服务分组。自定义。

ErrorCode String

错误码。取值说明如下:

  • 请求成功:不返回ErrorCode字段。
  • 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码列表。
Code String 200

接口状态或POP错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Success Boolean true

获取服务列表是否成功。取值说明如下:

  • true:获取成功。
  • false:获取失败。

示例

请求示例

GET /pop/v1/sam/service/listAppServicesPage?AppId=6dcc8c9e-d3da-478a-a066-86dcf820****&ServiceType=springCloud&PageNumber=1&PageSize=9999 HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

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

<ListAppServicesPageResponse>
    <RequestId>2583E089-99C2-562E-8B7E-73512136****</RequestId>
    <Message>success</Message>
    <TraceId>0be3e0c816394483660457498e****</TraceId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <TotalSize>1</TotalSize>
        <PageNumber>1</PageNumber>
        <PageSize>9999</PageSize>
        <Result>
            <EdasAppName>cn-zhangjiakou-micro-service-******</EdasAppName>
            <Version>1.0.0</Version>
            <InstanceNum>1</InstanceNum>
            <EdasAppId>hc4fs1****@98314c8790b****</EdasAppId>
            <ServiceName>edas.service.provider</ServiceName>
            <Group>springCloud</Group>
        </Result>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</ListAppServicesPageResponse>

JSON格式

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

{
  "RequestId" : "2583E089-99C2-562E-8B7E-73512136****",
  "Message" : "success",
  "TraceId" : "0be3e0c816394483660457498e****",
  "Data" : [ {
    "CurrentPage" : "1",
    "TotalSize" : "1",
    "PageNumber" : "1",
    "PageSize" : "9999",
    "Result" : [ {
      "EdasAppName" : "cn-zhangjiakou-micro-service-******",
      "Version" : "1.0.0",
      "InstanceNum" : 1,
      "EdasAppId" : "hc4fs1****@98314c8790b****",
      "ServiceName" : "edas.service.provider",
      "Group" : "springCloud"
    } ]
  } ],
  "Code" : "200",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 Micro.Service.NotFound The micro service not found {%s}. 服务不存在
400 InvalidParameter.Obviously The specified parameter is invalid {%s}. 不合法的参数{%s}。

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