DescribeAppServiceDetail - Serverless App Engine - Alibaba Cloud Documentation Center

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 common request headers. For more information, see Common request and response headers.

Request syntax

GET /pop/v1/sam/service/describeAppServiceDetail HTTP/1.1

Request parameters


Parameter	Type	Location	Required	Example	Description
AppId	String	Query	Yes	6dcc8c9e-d3da-478a-a066-86dcf820****	The ID of the application.
ServiceType	String	Query	No	springCloud	The type of the service. Valid values: dubbo springCloud
ServiceGroup	String	Query	No	springCloud	The group to which the service belongs. You can create a custom group.
ServiceVersion	String	Query	No	1.0.0	The version of the service. You can create a custom version.
ServiceName	String	Query	No	edas.service.provider	The name of the service.

Response parameters


Parameter	Type	Example	Description
RequestId	String	B2C7874F-F109-5B34-8618-2C10BBA2****	The ID of the request.
Message	String	success	The returned information.
TraceId	String	0b16399316402420740034918e****	The ID of the trace. The ID is used to query the details of a request.
Data	Object		The returned data.
Group	String	springCloud	The group to which the service belongs. You can create a custom group.
ServiceName	String	service-provider	The name of the service.
Version	String	1.0.0	The version of the service. You can create a custom version.
ServiceType	String	springCloud	The type of the service. Valid values: dubbo springCloud
EdasAppName	String	cn-zhangjiakou-micro-service-******	The name of the application.
Metadata	Map		The metadata. Example: `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`.
SpringApplicationName	String	service-provider	The name of the Spring Cloud application.
DubboApplicationName	String	service-consumer	The name of the Dubbo application.
Methods	Array of Method		The methods.
MethodController	String	com.serverless.sae.controller.EchoController	The class to which the method belongs.
ReturnType	String	java.lang.String	The data format of the response.
ReturnDetails	String	test	The details of the response.
Name	String	echo	The name of the method.
NameDetail	String	description	The details of the method.
ParameterDetails	Array of String	description	The details of the parameters.
RequestMethods	Array of String	ALL	The request methods. Valid values: GET ALL
ParameterTypes	Array of String	["java.lang.String"]	The types of the parameters.
Paths	Array of String	["/echo/{str}"]	The request paths. Format: `/path`
ParameterDefinitions	Array of ParameterDefinition		The definition of the parameter.
Type	String	java.lang.String	The type of the parameter.
Description	String	description	The description of the parameter.
Name	String	arg0	The name of the parameter.
ErrorCode	String	Empty	The returned error code. Valid values: If the call is successful, the ErrorCode parameter is not returned. If the call fails, the ErrorCode parameter is returned. For more information, see the "Error codes" section of this topic.
Code	String	200	The HTTP status code. Valid values: 2xx: indicates that the call was successful. 3xx: indicates that the call was redirected. 4xx: indicates that the call failed. 5xx: indicates that a server error occurred.
Success	Boolean	true	Indicates whether the meta data was obtained. Valid values: true: The metadata was obtained. false: The metadata failed to be obtained.

Examples

Sample requests

GET /pop/v1/sam/service/describeAppServiceDetail?AppId=6dcc8c9e-d3da-478a-a066-86dcf820****&ServiceType=springCloud&ServiceGroup=springCloud&ServiceVersion=1.0.0&ServiceName=edas.service.provider HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAppServiceDetailResponse>
    <RequestId>B2C7874F-F109-5B34-8618-2C10BBA2****</RequestId>
    <Message>success</Message>
    <TraceId>0b16399316402420740034918e****</TraceId>
    <Data>
        <Group>springCloud</Group>
        <ServiceName>service-provider</ServiceName>
        <Version>1.0.0</Version>
        <ServiceType>springCloud</ServiceType>
        <EdasAppName>cn-zhangjiakou-micro-service-******</EdasAppName>
        <SpringApplicationName>service-provider</SpringApplicationName>
        <DubboApplicationName>service-consumer</DubboApplicationName>
        <Methods>
            <MethodController>com.serverless.sae.controller.EchoController</MethodController>
            <ReturnType>java.lang.String</ReturnType>
            <ReturnDetails>test</ReturnDetails>
            <Name>echo</Name>
            <NameDetail>description</NameDetail>
            <ParameterDetails>description</ParameterDetails>
            <RequestMethods>ALL</RequestMethods>
            <ParameterTypes>["java.lang.String"]</ParameterTypes>
            <Paths>["/echo/{str}"]</Paths>
            <ParameterDefinitions>
                <Type>java.lang.String</Type>
                <Description>description</Description>
                <Name>arg0</Name>
            </ParameterDefinitions>
        </Methods>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeAppServiceDetailResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message" : "success",
  "TraceId" : "0b16399316402420740034918e****",
  "Data" : {
    "Group" : "springCloud",
    "ServiceName" : "service-provider",
    "Version" : "1.0.0",
    "ServiceType" : "springCloud",
    "EdasAppName" : "cn-zhangjiakou-micro-service-******",
    "SpringApplicationName" : "service-provider",
    "DubboApplicationName" : "service-consumer",
    "Methods" : [ {
      "MethodController" : "com.serverless.sae.controller.EchoController",
      "ReturnType" : "java.lang.String",
      "ReturnDetails" : "test",
      "Name" : "echo",
      "NameDetail" : "description",
      "ParameterDetails" : [ "description" ],
      "RequestMethods" : [ "ALL" ],
      "ParameterTypes" : [ "[\"java.lang.String\"]" ],
      "Paths" : [ "[\"/echo/{str}\"]" ],
      "ParameterDefinitions" : [ {
        "Type" : "java.lang.String",
        "Description" : "description",
        "Name" : "arg0"
      } ]
    } ]
  },
  "Code" : "200",
  "Success" : true
}

Error codes


HttpCode	Error code	Error message	Description
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.	The error message returned because the metadata of the microservice does not exist.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	The error message returned because the value of the {%s} parameter is invalid.

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