调用GetServiceMethodPage接口获取服务接口元数据列表。

调试

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

请求头

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

请求语法

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

请求参数

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

地域ID。
namespace String Query 否 cn-hangzhou:doc-test

命名空间ID。
origin String Query 否 agent

数据来源。取值如下：

  • agent：新版服务查询需要传递。
  • registry：旧版服务查询传递。
serviceType String Query 否 springCloud

服务类型。
appId String Query 否 310b18c3-1dbe-4807-****-18d7d637****

应用ID。
source String Query 否 edas

来源，固定值：edas。
serviceId String Query 否 edas.service.consumer

服务ID。
serviceName String Query 否 edas.service.consumer

服务名称。
serviceVersion String Query 否 1.0.0

服务版本。
group String Query 否 DUBBO

分组。
ip String Query 否 127.0.0.1

IP地址。
registryType String Query 否 nacos

注册中心类型。
pageNumber Integer Query 否 1

页号。
pageSize Integer Query 否 10

分页大小。
methodController String Query 否 com.aliware.edas.DemoController

controller方法。
path String Query 否 /echo/{str}

请求路径。
name String Query 否 echo

方法名。

返回数据

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

接口状态或POP错误码。
Data Struct

数据结构体。
PageNumber Integer 1

页号。
PageSize Integer 10

分页大小。
Result Array of Method

方法结构体。
MethodController String com.aliware.edas.EchoController

方法。
Name String echo

方法名。
NameDetail String name

方法详情。
ParameterDefinitions String [{"description":"","name":"arg0","type":"java.lang.String"}]

参数定义。
ParameterDetails String {}

参数详情。
ParameterNames String echo

参数名称。
ParameterTypes String java.lang.String

参数类型。
Paths String /consumer/alive

方法路径。
RequestMethods String GET

请求方法。
ReturnDefinition Struct

返回值。
Id String 1

返回值ID。
Type String java.lang.String

返回类型。
ReturnDetails String java.lang.String

返回详情。
ReturnType String java.lang.String

返回类型。
TotalSize Integer 6

总数。
HttpCode String 200

HTTP响应码。
Message String success

附加信息。
RequestId String BDC0C0FE-D63B-4FC8-****-4081C57E****

请求ID。
Success Boolean true

调用是否成功。

示例

请求示例

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

正常返回示例

XML格式 

<GetServiceMethodPage>
  <HttpCode>200</HttpCode>
  <RequestId>BDC0C0FE-D63B-4FC8-****-4081C57E****</RequestId>
  <Message>success</Message>
  <Data>
        <PageSize>10</PageSize>
        <PageNumber>1</PageNumber>
        <TotalSize>6</TotalSize>
        <Result>
              <ParameterDefinitions>[{"description":"","name":"arg0","type":"java.lang.String"}]</ParameterDefinitions>
              <ParameterNames>echo</ParameterNames>
              <ParameterDetails>{}</ParameterDetails>
              <MethodController>com.aliware.edas.EchoController</MethodController>
              <Paths>/consumer/alive</Paths>
              <RequestMethods>GET</RequestMethods>
              <ParameterTypes>java.lang.String</ParameterTypes>
              <ReturnType>java.lang.String</ReturnType>
              <ReturnDetails>java.lang.String</ReturnDetails>
              <NameDetail>name</NameDetail>
              <Name>echo</Name>
        </Result>
        <Result>
              <ReturnDefinition>
                    <Type>java.lang.String</Type>
                    <Id>1</Id>
              </ReturnDefinition>
        </Result>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</GetServiceMethodPage>

JSON格式 

{
    "HttpCode": 200,
    "RequestId": "BDC0C0FE-D63B-4FC8-****-4081C57E****",
    "Message": "success",
    "Data": {
        "PageSize": 10,
        "PageNumber": 1,
        "TotalSize": 6,
        "Result": [
            {
                "ParameterDefinitions": "[{\"description\":\"\",\"name\":\"arg0\",\"type\":\"java.lang.String\"}]",
                "ParameterNames": "echo",
                "ParameterDetails": "{}",
                "MethodController": "com.aliware.edas.EchoController",
                "Paths": "/consumer/alive",
                "RequestMethods": "GET",
                "ParameterTypes": "java.lang.String",
                "ReturnType": "java.lang.String",
                "ReturnDetails": "java.lang.String",
                "NameDetail": "name",
                "Name": "echo"
            },
            {
                "ReturnDefinition": {
                    "Type": "java.lang.String",
                    "Id": 1
                }
            }
        ]
    },
    "Code": 200,
    "Success": true
}