调用GetServiceMethodPage接口获取服务接口元数据列表_企业级分布式应用服务(EDAS)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
edas:ReadService	get	*NameSpace `acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}`	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
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>	方法结构体。
Method	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

示例

正常返回示例

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
        }
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史