GetServiceMethodPage - 查询微服务方法列表 - 企业级分布式应用服务 EDAS

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
region	string	否	地域ID。	cn-hangzhou
namespace	string	否	命名空间ID。	cn-hangzhou:doc-test
origin	string	否	数据来源。取值如下： agent：新版服务查询需要传递。 registry：旧版服务查询传递。	agent
serviceType	string	否	服务类型，支持以下类型： dubbo：Dubbo服务。 springCloud：SpringCloud服务。 hsf：HSF服务。	springCloud
appId	string	否	应用ID。	310b18c3-1dbe-4807-**-18d7d637**
source	string	否	来源，固定值：edas。	edas
serviceId	string	否	服务ID。	edas.service.consumer
serviceName	string	否	服务名称。	edas.service.consumer
serviceVersion	string	否	服务版本。	1.0.0
group	string	否	分组。	DUBBO
ip	string	否	IP地址。	127.0.0.1
registryType	string	否	注册中心类型。	nacos
pageNumber	integer	否	页号。	1
pageSize	integer	否	分页大小。	10
methodController	string	否	controller方法。	com.aliware.edas.DemoController
path	string	否	请求路径。	/echo/{str}
name	string	否	方法名。	echo

返回参数

名称	类型	描述	示例值
	object
Code	string	接口状态或POP错误码。	200
Message	string	附加信息。	success
HttpCode	string	HTTP响应码。	200
RequestId	string	请求ID。	BDC0C0FE-D63B-4FC8-**-4081C57E**
Success	boolean	调用是否成功。	true
Data	object	数据结构体。
PageNumber	integer	页号。	1
PageSize	integer	分页大小。	10
TotalSize	integer	总数。	6
Result	array	方法结构体。
	object
ParameterDetails	string	参数详情。	{}
NameDetail	string	方法详情。	name
ParameterNames	string	参数名称。	echo
ParameterDefinitions	string	参数定义。	[{"description":"","name":"arg0","type":"java.lang.String"}]
Paths	string	方法路径。	/consumer/alive
ParameterTypes	string	参数类型。	java.lang.String
RequestMethods	string	请求方法。	GET
ReturnDetails	string	返回详情。	java.lang.String
Name	string	方法名。	echo
MethodController	string	方法。	com.aliware.edas.EchoController
ReturnType	string	返回类型。	java.lang.String
ReturnDefinition	object	返回值。
Type	string	返回类型。	java.lang.String
Id	string	返回值ID。	1

示例

请求示例

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

正常返回示例

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
}

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>