GetServiceMethodPage - Enterprise Distributed Application Service

Queries service methods.

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 supports 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

edas:ReadService

get

*NameSpace

acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
region	string	No	The ID of the region.	cn-hangzhou
namespace	string	No	The ID of the namespace.	cn-hangzhou:doc-test
origin	string	No	The source of the data. Valid values: agent: Use this value if you use the service query feature of the latest version to pass the query result. registry: Use this value if you use the service query feature of the earlier version to pass the query result.	agent
serviceType	string	No	The type of the service. Valid values: dubbo: Dubbo service springCloud: Spring Cloud service hsf: High-speed Service Framework (HSF) service	springCloud
appId	string	No	The ID of the application.	310b18c3-1dbe-4807-**-18d7d637**
source	string	No	The source of the service. Set the value to edas.	edas
serviceId	string	No	The ID of the service.	edas.service.consumer
serviceName	string	No	The name of the service.	edas.service.consumer
serviceVersion	string	No	The version of the service.	1.0.0
group	string	No	The group to which the service belongs.	DUBBO
ip	string	No	The IP address of the service.	127.0.0.1
registryType	string	No	The type of the service registry.	nacos
pageNumber	integer	No	The number of the page to return.	1
pageSize	integer	No	The number of entries to return on each page.	10
methodController	string	No	The controller method.	com.aliware.edas.DemoController
path	string	No	The request path.	/echo/{str}
name	string	No	The name of the method.	echo

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
HttpCode	string	The HTTP status code that is returned.	200
RequestId	string	The ID of the request.	BDC0C0FE-D63B-4FC8-**-4081C57E**
Success	boolean	Indicates whether the request is successful.	true
Data	object	The data that is returned.
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalSize	integer	The total number of entries.	6
Result	array<object>	The data about the method.
	array<object>
ParameterDetails	string	The details of the parameters.	{}
NameDetail	string	The details of the method.	name
ParameterNames	string	The name of the parameter.	echo
ParameterDefinitions	string	The definition of the parameter.	[{"description":"","name":"arg0","type":"java.lang.String"}]
Paths	string	The method path.	/consumer/alive
ParameterTypes	string	The data type of the parameter.	java.lang.String
RequestMethods	string	The request method.	GET
ReturnDetails	string	The details of the response.	java.lang.String
Name	string	The name of the method.	echo
MethodController	string	The method.	com.aliware.edas.EchoController
ReturnType	string	The data format of the response.	java.lang.String
ReturnDefinition	object	The return value.
Type	string	The data format of the response.	java.lang.String
Id	string	The ID of the return value.	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.