Queries service details.

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 uses only the common request header. For more information, see Common request parameters.

Request syntax

POST|GET /pop/sp/api/mseForOam/getServiceDetail 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 data source. Valid values:

  • agent: Use this value if you use the service query feature of the new version.
  • registry: Use this value if you use the service query feature of the previous version.
serviceType String Query No springCloud

The type of the service. Valid values:

  • dubbo
  • springCloud
  • hsf
  • istio
appId String Query No efbda488-7b33-432f-a40d-****0047****

The ID of the application.

source String Query No edas

The source. Set the value to edas.

serviceId String Query No com.alibabacloud.hipstershop.CartService

The ID of the service. This parameter is obsolete and you can ignore it.

serviceName String Query No com.alibabacloud.hipstershop.CartService

The name of the service.

serviceVersion String Query No 1.0.0

The version of the service.

group String Query No DUBBO

The group to which the service belongs.

ip String Query No 10.20.x.xx

The IP address of the service provider. Fuzzy queries are supported.

registryType String Query No nacos

The registry type. This parameter is obsolete and you can ignore it.

Response parameters

Parameter Type Example Description
Code Integer 200

The HTTP status code.

Data Struct

The data struct.

DubboApplicationName String cartservice

The name of the Dubbo application.

EdasAppName String test123

The name of the Enterprise Distributed Application Service (EDAS) application.

Group String dubbo

The group to which the service belongs.

Metadata String {}

The metadata.

Methods Array of Method

The method list.

MethodController String com.aliware.edas.DemoController

The controller list.

Name String feign2

The name.

NameDetail String test

The specific name.

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

The parameter definitions.

ParameterDetails String {}

The parameter details.

ParameterNames String test

The parameter names.

ParameterTypes String ["java.lang.String"]

The parameter types.

Paths String ["/consumer-echo/feign/{str}"]

The method path.

RequestMethods String GET

The request method.

ReturnDefinition Struct

The definition of the value that is returned by the method.

Id String 1

The ID of the value that is returned by the method.

Type String foo

The type.

ReturnDetails String test

The details returned by the method.

ReturnType String java.lang.String

The data format of the value returned by the method.

RegistryType String agent

The registry type.

ServiceName String edas.service.consumer

The name of the service.

ServiceType String springCloud

The type of the service.

SpringApplicationName String edas.service.consumer

The name of the Spring application.

Version String 1.0.0

The version number.

Message String success

The message returned for the request.

Success Boolean true

Indicates whether the call is successful.

Examples

Sample requests

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

Sample success responses

XML format

<GetServiceDetail>
  <Message>success</Message>
  <Data>
        <Group>dubbo</Group>
        <RegistryType>agent</RegistryType>
        <Version>1.0.0</Version>
        <ServiceName>edas.service.consumer</ServiceName>
        <ServiceType>springCloud</ServiceType>
        <EdasAppName>test123</EdasAppName>
        <Metadata>{}</Metadata>
        <SpringApplicationName>edas.service.consumer</SpringApplicationName>
        <Methods>
              <ParameterDefinitions>[{"description":"","name":"arg0","type":"java.lang.String"}]</ParameterDefinitions>
              <ParameterNames>test</ParameterNames>
              <ParameterDetails>{}</ParameterDetails>
              <MethodController>com.aliware.edas.DemoController</MethodController>
              <Paths>["/consumer-echo/feign/{str}"]</Paths>
              <RequestMethods>GET</RequestMethods>
              <ParameterTypes>["java.lang.String"]</ParameterTypes>
              <ReturnType>java.lang.String</ReturnType>
              <ReturnDetails>test</ReturnDetails>
              <NameDetail>test</NameDetail>
              <Name>feign2</Name>
        </Methods>
        <Methods>
              <ReturnDefinition>
                    <Type>foo</Type>
                    <Id>1</Id>
              </ReturnDefinition>
        </Methods>
        <DubboApplicationName>cartservice</DubboApplicationName>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</GetServiceDetail>

JSON format

{
    "Message": "success",
    "Data": {
        "Group": "dubbo",
        "RegistryType": "agent",
        "Version": "1.0.0",
        "ServiceName": "edas.service.consumer",
        "ServiceType": "springCloud",
        "EdasAppName": "test123",
        "Metadata": "{}",
        "SpringApplicationName": "edas.service.consumer",
        "Methods": [
            {
                "ParameterDefinitions": "[{\"description\":\"\",\"name\":\"arg0\",\"type\":\"java.lang.String\"}]",
                "ParameterNames": "test",
                "ParameterDetails": "{}",
                "MethodController": "com.aliware.edas.DemoController",
                "Paths": "[\"/consumer-echo/feign/{str}\"]",
                "RequestMethods": "GET",
                "ParameterTypes": "[\"java.lang.String\"]",
                "ReturnType": "java.lang.String",
                "ReturnDetails": "test",
                "NameDetail": "test",
                "Name": "feign2"
            },
            {
                "ReturnDefinition": {
                    "Type": "foo",
                    "Id": 1
                }
            }
        ],
        "DubboApplicationName": "cartservice"
    },
    "Code": 200,
    "Success": true
}

Error codes

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