GetServiceMethodPage - Microservices Engine - Alibaba Cloud Documentation Center

Queries a list of service interfaces.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:GetServiceMethodPage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region.	cn-hangzhou
ServiceType	string	No	The engine type.	springCloud
Namespace	string	No	The Microservices Engine (MSE) namespace to which the application belongs.	default
AppName	string	No	The application name.	example-app
AppId	string	No	The application ID.	hkhonxxxxx@f3f75ed8ffxxxxx
ServiceName	string	No	The name of the service.	sc-A
ServiceVersion	string	No	The service version.	1.0.0
ServiceGroup	string	No	The group to which the service belongs.
Ip	string	No	The IP address of the service provider.	223.5.5.5
PageNumber	integer	No	The page number of the returned page.	1
PageSize	integer	No	The number of entries per page.	10
MethodController	string	No	The full name of the Controller class to which the interface belongs.	com.alibabacloud.mse.demo.a.AController
Path	string	No	The request path that corresponds to the interface.	/a
Name	string	No	The method name.	aMethod
AcceptLanguage	string	No	The language in which you want the results to be displayed. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.	zh

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful. Valid values:	True
Message	string	The request information.	OK
RequestId	string	The request ID.	2DD5A212-C77B-3XXF-9XXE-XXX9XXXE5XX1
Data	object	The response to the request.
Result	array	The method description list.
	object	The description of each method.
NameDetail	string	The interface description information.	示例接口描述信息。
ParameterDetails	array	The type of the interface parameter.
	string	The type of each parameter.	java.lang.String
ParameterDefinitions	array	The detailed definition of the parameter.
	object	The detailed definition of the parameter.
Type	string	The parameter type.	java.lang.String
Description	string	The description of the parameter.	参数描述示例
Name	string	The name of the parameter.	aParam
Paths	array	The list of request paths that correspond to the interface.
	string	The request path that corresponds to the interface.	/a
ParameterTypes	array	The parameter types.
	string	The parameter type.	java.lang.String
RequestMethods	array	The HTTP request method.
	string	The HTTP request parameter.	GET
ReturnDetails	string	The type of the return value.	java.lang.String
Name	string	The name of the method.	aMethod
MethodController	string	The full name of the Controller class to which the interface belongs.	com.alibabacloud.mse.demo.a.AController
ReturnType	string	The type of the return value.	java.lang.String
TotalSize	integer	The total number of methods.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "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
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.