DescribeAppServiceDetail - Serverless App Engine - Alibaba Cloud Documentation Center

Describes the metadata details of an application service.

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

sae:DescribeAppServiceDetail

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	No	The service type. Valid values: dubbo springCloud	springCloud
ServiceGroup	string	No	The service group. This is a custom parameter.	springCloud
ServiceVersion	string	No	The service version. This is a custom parameter.	1.0.0
ServiceName	string	No	The service name.	edas.service.provider
NacosInstanceId	string	No	The ID of the MSE Nacos instance.	mse-cn-sco3r0u****
NacosNamespaceId	string	No	The ID of the MSE Nacos namespace.	public

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	The additional information returned.	success
TraceId	string	The call chain ID. Use this ID for a term query of call details.	0b16399316402420740034918e****
Data	object	The returned data.
Group	string	The service group. This is a custom parameter.	springCloud
ServiceName	string	The service name.	service-provider
Version	string	The service version. This is a custom parameter.	1.0.0
ServiceType	string	The service type. Valid values: dubbo springCloud	springCloud
ServiceProtocol	string	The protocol used by the service.	HTTP
ServicePorts	array	The ports used by the service.
	integer	The port number.	8000
ServiceTags	array	The tags of the service.
	string	The tag of the service.	tag1
EdasAppName	string	The application name.	cn-zhangjiakou-micro-service-******
Metadata	object	The metadata. Example: `{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	The name of the Spring Cloud application.	service-provider
DubboApplicationName	string	The name of the Dubbo application.	service-consumer
Methods	array<object>	The list of methods.
	array<object>	The list of methods.
MethodController	string	The class to which the method belongs.	com.serverless.sae.controller.EchoController
ReturnType	string	The return type.	java.lang.String
ReturnDetails	string	The details of the returned data.	test
Name	string	The method name.	echo
NameDetail	string	The details of the method.	description
ParameterDetails	array	The details of the parameters.
	string	The details of the parameter.	description
RequestMethods	array	The request methods.
	string	The request method. Valid values: GET ALL	ALL
ParameterTypes	array	The parameter types.
	string	The parameter type.	["java.lang.String"]
Paths	array	The request paths.
	string	The request path. The format is as follows: `/path`	["/echo/{str}"]
ParameterDefinitions	array<object>	The parameter definitions.
	object	The parameter definition.
Type	string	The parameter type.	java.lang.String
Description	string	The description of the parameter.	description
Name	string	The parameter name.	arg0
ErrorCode	string	The error code. If the request is successful, the ErrorCode field is not returned. If the request fails, the ErrorCode field is returned. For more information, see the list of error codes in this topic.	空
Code	string	The status of the API call or a POP error code. Valid values: 2xx: success. 3xx: redirection. 4xx: client error. 5xx: server error.	200
Success	boolean	Indicates whether the metadata was obtained. Valid values: true: The metadata was obtained. false: The metadata failed to be obtained.	true

Examples

Success response

JSON format

{
  "RequestId": "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message": "success",
  "TraceId": "0b16399316402420740034918e****",
  "Data": {
    "Group": "springCloud",
    "ServiceName": "service-provider",
    "Version": "1.0.0",
    "ServiceType": "springCloud",
    "ServiceProtocol": "HTTP",
    "ServicePorts": [
      8000
    ],
    "ServiceTags": [
      "tag1"
    ],
    "EdasAppName": "cn-zhangjiakou-micro-service-******",
    "Metadata": {
      "test": "test",
      "test2": 1
    },
    "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"
          }
        ]
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.