All Products
Search
Document Center

Enterprise Distributed Application Service:GetServiceMethodPage

Last Updated:Jan 08, 2024

Queries service methods.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /pop/sp/api/mseForOam/getServiceMethodPage

GET /pop/sp/api/mseForOam/getServiceMethodPage

Request parameters

ParameterTypeRequiredDescriptionExample
regionstringNo

The ID of the region.

cn-hangzhou
namespacestringNo

The ID of the namespace.

cn-hangzhou:doc-test
originstringNo

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
serviceTypestringNo

The type of the service. Valid values:

  • dubbo: Dubbo service
  • springCloud: Spring Cloud service
  • hsf: High-speed Service Framework (HSF) service
springCloud
appIdstringNo

The ID of the application.

310b18c3-1dbe-4807-****-18d7d637****
sourcestringNo

The source of the service. Set the value to edas.

edas
serviceIdstringNo

The ID of the service.

edas.service.consumer
serviceNamestringNo

The name of the service.

edas.service.consumer
serviceVersionstringNo

The version of the service.

1.0.0
groupstringNo

The group to which the service belongs.

DUBBO
ipstringNo

The IP address of the service.

127.0.0.1
registryTypestringNo

The type of the service registry.

nacos
pageNumberintegerNo

The number of the page to return.

1
pageSizeintegerNo

The number of entries to return on each page.

10
methodControllerstringNo

The controller method.

com.aliware.edas.DemoController
pathstringNo

The request path.

/echo/{str}
namestringNo

The name of the method.

echo

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
HttpCodestring

The HTTP status code that is returned.

200
RequestIdstring

The ID of the request.

BDC0C0FE-D63B-4FC8-****-4081C57E****
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data that is returned.

PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
TotalSizeinteger

The total number of entries.

6
Resultobject []

The data about the method.

ParameterDetailsstring

The details of the parameters.

{}
NameDetailstring

The details of the method.

name
ParameterNamesstring

The name of the parameter.

echo
ParameterDefinitionsstring

The definition of the parameter.

[{"description":"","name":"arg0","type":"java.lang.String"}]
Pathsstring

The method path.

/consumer/alive
ParameterTypesstring

The data type of the parameter.

java.lang.String
RequestMethodsstring

The request method.

GET
ReturnDetailsstring

The details of the response.

java.lang.String
Namestring

The name of the method.

echo
MethodControllerstring

The method.

com.aliware.edas.EchoController
ReturnTypestring

The data format of the response.

java.lang.String
ReturnDefinitionobject

The return value.

Typestring

The data format of the response.

java.lang.String
Idstring

The ID of the return value.

1

Examples

Sample success responses

JSONformat

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

For a list of error codes, visit the Service error codes.