文档

GetServiceMethodPage - 查询微服务方法列表

更新时间:

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

调试

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

调试

授权信息

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

请求语法

POST /pop/sp/api/mseForOam/getServiceMethodPage

GET /pop/sp/api/mseForOam/getServiceMethodPage

请求参数

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

地域 ID。

cn-hangzhou
namespacestring

命名空间 ID。

cn-hangzhou:doc-test
originstring

数据来源。取值如下:

  • agent:新版服务查询需要传递。
  • registry:旧版服务查询传递。
agent
serviceTypestring

服务类型,支持以下类型:

  • dubbo:Dubbo 服务。
  • springCloud:SpringCloud 服务。
  • hsf:HSF 服务。
springCloud
appIdstring

应用 ID。

310b18c3-1dbe-4807-****-18d7d637****
sourcestring

来源,固定值:edas。

edas
serviceIdstring

服务 ID。

edas.service.consumer
serviceNamestring

服务名称。

edas.service.consumer
serviceVersionstring

服务版本。

1.0.0
groupstring

分组。

DUBBO
ipstring

IP 地址。

127.0.0.1
registryTypestring

注册中心类型。

nacos
pageNumberinteger

页号。

1
pageSizeinteger

分页大小。

10
methodControllerstring

controller 方法。

com.aliware.edas.DemoController
pathstring

请求路径。

/echo/{str}
namestring

方法名。

echo

返回参数

名称类型描述示例值
object
Codestring

接口状态或 POP 错误码。

200
Messagestring

附加信息。

success
HttpCodestring

HTTP 响应码。

200
RequestIdstring

请求 ID。

BDC0C0FE-D63B-4FC8-****-4081C57E****
Successboolean

调用是否成功。

true
Dataobject

数据结构体。

PageNumberinteger

页号。

1
PageSizeinteger

分页大小。

10
TotalSizeinteger

总数。

6
Resultobject []

方法结构体。

ParameterDetailsstring

参数详情。

{}
NameDetailstring

方法详情。

name
ParameterNamesstring

参数名称。

echo
ParameterDefinitionsstring

参数定义。

[{"description":"","name":"arg0","type":"java.lang.String"}]
Pathsstring

方法路径。

/consumer/alive
ParameterTypesstring

参数类型。

java.lang.String
RequestMethodsstring

请求方法。

GET
ReturnDetailsstring

返回详情。

java.lang.String
Namestring

方法名。

echo
MethodControllerstring

方法。

com.aliware.edas.EchoController
ReturnTypestring

返回类型。

java.lang.String
ReturnDefinitionobject

返回值。

Typestring

返回类型。

java.lang.String
Idstring

返回值 ID。

1

示例

正常返回示例

JSON格式

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

错误码

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

  • 本页导读 (1)
文档反馈