Queries the service interface metadata.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation only uses the common request header. For more information, see Common request parameters.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
region String Query No cn-hangzhou

The ID of the region.

namespace String Query No cn-hangzhou:doc-test

The ID of the namespace.

origin String Query No agent

The source of the data. Valid values:

  • agent: required if you use the new service query feature to pass the query result.
  • registry: required if you use the earlier service query feature to pass the query result.
serviceType String Query No springCloud

The type of the service.

appId String Query No 310b18c3-1dbe-4807-****-18d7d637****

The ID of the application.

source String Query No edas

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

serviceId String Query No edas.service.consumer

The ID of the service.

serviceName String Query No edas.service.consumer

The name of the service.

serviceVersion String Query No 1.0.0

The version of the service.

group String Query No DUBBO

The service group.

ip String Query No 127.0.0.1

The IP address.

registryType String Query No nacos

The type of the registration center.

pageNumber Integer Query No 1

The number of the page to return.

pageSize Integer Query No 10

The number of entries to return on each page.

methodController String Query No com.aliware.edas.DemoController

The method of the controller.

path String Query No /echo/{str}

The path of the request.

name String Query No echo

The name of the method.

Response parameters

Parameter Type Example Description
Code String 200

The returned HTTP status code.

Data Struct

The data struct.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

Result Array of Method

The struct for the method returned.

MethodController String com.aliware.edas.EchoController

The returned controller method.

Name String echo

The name of the method.

NameDetail String name

The details of the method.

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

The parameter definitions.

ParameterDetails String {}

The parameter details.

ParameterNames String echo

The name of the parameter.

ParameterTypes String java.lang.String

The type of the parameter.

Paths String /consumer/alive

The method path.

RequestMethods String GET

The request method.

ReturnDefinition Struct

The return value.

Id String 1

The ID of the return value.

Type String java.lang.String

The data format of the response.

ReturnDetails String java.lang.String

The details of the response.

ReturnType String java.lang.String

The data format of the response.

TotalSize Integer 6

The total number of entries returned.

HttpCode String 200

The returned HTTP response status code.

Message String success

The returned message.

RequestId String BDC0C0FE-D63B-4FC8-****-4081C57E****

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Examples

Sample requests

POST /pop/sp/api/mseForOam/getServiceMethodPage HTTP/1.1
Common request parameters

Sample success responses

XML format

<GetServiceMethodPage>
  <HttpCode>200</HttpCode>
  <RequestId>BDC0C0FE-D63B-4FC8-****-4081C57E****</RequestId>
  <Message>success</Message>
  <Data>
        <PageSize>10</PageSize>
        <PageNumber>1</PageNumber>
        <TotalSize>6</TotalSize>
        <Result>
              <ParameterDefinitions>[{"description":"","name":"arg0","type":"java.lang.String"}]</ParameterDefinitions>
              <ParameterNames>echo</ParameterNames>
              <ParameterDetails>{}</ParameterDetails>
              <MethodController>com.aliware.edas.EchoController</MethodController>
              <Paths>/consumer/alive</Paths>
              <RequestMethods>GET</RequestMethods>
              <ParameterTypes>java.lang.String</ParameterTypes>
              <ReturnType>java.lang.String</ReturnType>
              <ReturnDetails>java.lang.String</ReturnDetails>
              <NameDetail>name</NameDetail>
              <Name>echo</Name>
        </Result>
        <Result>
              <ReturnDefinition>
                    <Type>java.lang.String</Type>
                    <Id>1</Id>
              </ReturnDefinition>
        </Result>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</GetServiceMethodPage>

JSON format

{
    "HttpCode": 200,
    "RequestId": "BDC0C0FE-D63B-4FC8-****-4081C57E****",
    "Message": "success",
    "Data": {
        "PageSize": 10,
        "PageNumber": 1,
        "TotalSize": 6,
        "Result": [
            {
                "ParameterDefinitions": "[{\"description\":\"\",\"name\":\"arg0\",\"type\":\"java.lang.String\"}]",
                "ParameterNames": "echo",
                "ParameterDetails": "{}",
                "MethodController": "com.aliware.edas.EchoController",
                "Paths": "/consumer/alive",
                "RequestMethods": "GET",
                "ParameterTypes": "java.lang.String",
                "ReturnType": "java.lang.String",
                "ReturnDetails": "java.lang.String",
                "NameDetail": "name",
                "Name": "echo"
            },
            {
                "ReturnDefinition": {
                    "Type": "java.lang.String",
                    "Id": 1
                }
            }
        ]
    },
    "Code": 200,
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.