全部产品
Search
文档中心

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

更新时间:Nov 13, 2024

获取服务接口列表。

调试

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

授权信息

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

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

请求参数

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

地域。

cn-hangzhou
ServiceTypestring

服务类型。

springCloud
Namespacestring

应用所属的 MSE 命名空间。

default
AppNamestring

应用名称

example-app
AppIdstring

应用 id。

hkhonxxxxx@f3f75ed8ffxxxxx
ServiceNamestring

服务名。

sc-A
ServiceVersionstring

服务版本。

1.0.0
ServiceGroupstring

服务分组。

ALIYUN
Ipstring

服务提供者 ip。

223.5.5.5
PageNumberinteger

获取第几页的数据。

1
PageSizeinteger

每一页多少条。

10
MethodControllerstring

接口所在的 Controller 类全称。

com.alibabacloud.mse.demo.a.AController
Pathstring

接口对应的请求路径。

/a
Namestring

方法名。

aMethod
AcceptLanguagestring

返回结果显示的语言。取值:zh(默认值):中文,en:英文

zh

返回参数

名称类型描述示例值
object
Successboolean

请求是否成功。

True
Messagestring

请求信息。

OK
RequestIdstring

请求 id。

2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1
Dataobject

请求响应数据。

Resultarray<object>

方法描述列表。

Methodobject

每个方法描述。

NameDetailstring

接口描述信息。

示例接口描述信息。
ParameterDetailsarray

接口参数类型。

ParameterDetailstring

每个参数的类型。

java.lang.String
ParameterDefinitionsarray<object>

参数的详细定义。

ParameterDefinitionobject

参数的详细定义。

Typestring

参数类型。

java.lang.String
Descriptionstring

参数描述。

参数描述示例
Namestring

参数名字。

aParam
Pathsarray

接口对应的请求路径列表。

Pathstring

接口对应的请求路径。

/a
ParameterTypesarray

参数类型。

ParameterTypestring

参数类型。

java.lang.String
RequestMethodsarray

HTTP 请求方法。

RequestMethodstring

HTTP 请求参数。

GET
ReturnDetailsstring

返回值类型。

java.lang.String
Namestring

方法名。

aMethod
MethodControllerstring

接口所在的 Controller 类全称。

com.alibabacloud.mse.demo.a.AController
ReturnTypestring

返回值类型。

java.lang.String
TotalSizeinteger

方法总数量。

100
PageNumberinteger

第几页。

1
PageSizeinteger

每页大小

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错误码错误信息描述
400IllegalRequestInvalid request:%s非法请求: %s
400InvalidParameterParameter error:%s请求参数错误:%s
403NoPermissionYou are not authorized to perform this operation:%s没有权限使用此接口:%s
404NotFoundNot found:%s资源不存在:%s
500InternalErrorConsole error. Try again later:%s控制台错误.稍后重试:%s

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

变更历史

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