GetServiceMethodPage - 获取服务方法列表 - 微服务引擎MSE

获取服务接口列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
mse:GetServiceMethodPage	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Region	string	否	地域。	cn-hangzhou
ServiceType	string	否	服务类型。	springCloud
Namespace	string	否	应用所属的 MSE 命名空间。	default
AppName	string	否	应用名称	example-app
AppId	string	否	应用 id。	hkhonxxxxx@f3f75ed8ffxxxxx
ServiceName	string	否	服务名。	sc-A
ServiceVersion	string	否	服务版本。	1.0.0
ServiceGroup	string	否	服务分组。	ALIYUN
Ip	string	否	服务提供者 ip。	223.5.5.5
PageNumber	integer	否	获取第几页的数据。	1
PageSize	integer	否	每一页多少条。	10
MethodController	string	否	接口所在的 Controller 类全称。	com.alibabacloud.mse.demo.a.AController
Path	string	否	接口对应的请求路径。	/a
Name	string	否	方法名。	aMethod
AcceptLanguage	string	否	返回结果显示的语言。取值：zh（默认值）：中文，en：英文	zh

返回参数

名称	类型	描述	示例值
	object
Success	boolean	请求是否成功。	True
Message	string	请求信息。	OK
RequestId	string	请求 id。	2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1
Data	object	请求响应数据。
Result	array<object>	方法描述列表。
Method	object	每个方法描述。
NameDetail	string	接口描述信息。	示例接口描述信息。
ParameterDetails	array	接口参数类型。
ParameterDetail	string	每个参数的类型。	java.lang.String
ParameterDefinitions	array<object>	参数的详细定义。
ParameterDefinition	object	参数的详细定义。
Type	string	参数类型。	java.lang.String
Description	string	参数描述。	参数描述示例
Name	string	参数名字。	aParam
Paths	array	接口对应的请求路径列表。
Path	string	接口对应的请求路径。	/a
ParameterTypes	array	参数类型。
ParameterType	string	参数类型。	java.lang.String
RequestMethods	array	HTTP 请求方法。
RequestMethod	string	HTTP 请求参数。	GET
ReturnDetails	string	返回值类型。	java.lang.String
Name	string	方法名。	aMethod
MethodController	string	接口所在的 Controller 类全称。	com.alibabacloud.mse.demo.a.AController
ReturnType	string	返回值类型。	java.lang.String
TotalSize	integer	方法总数量。	100
PageNumber	integer	第几页。	1
PageSize	integer	每页大小	10

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Message": "OK",
  "RequestId": "2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1",
  "Data": {
    "Result": [
      {
        "NameDetail": "示例接口描述信息。",
        "ParameterDetails": [
          "java.lang.String"
        ],
        "ParameterDefinitions": [
          {
            "Type": "java.lang.String",
            "Description": "参数描述示例",
            "Name": "aParam"
          }
        ],
        "Paths": [
          "/a"
        ],
        "ParameterTypes": [
          "java.lang.String"
        ],
        "RequestMethods": [
          "GET"
        ],
        "ReturnDetails": "java.lang.String",
        "Name": "aMethod",
        "MethodController": "com.alibabacloud.mse.demo.a.AController",
        "ReturnType": "java.lang.String"
      }
    ],
    "TotalSize": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalRequest	Invalid request:%s	非法请求： %s
400	InvalidParameter	Parameter error:%s	请求参数错误：%s
403	NoPermission	You are not authorized to perform this operation:%s	没有权限使用此接口：%s
404	NotFound	Not found:%s	资源不存在：%s
500	InternalError	Console error. Try again later:%s	控制台错误.稍后重试：%s

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

变更历史

变更时间	变更内容概要	操作
2023-09-13	OpenAPI 入参发生变更	查看变更详情