DescribeAppServiceDetail - DescribeAppServiceDetail_Serverless 应用引擎(SAE)-阿里云帮助中心

调用DescribeAppServiceDetail接口获取应用服务的元数据详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sae:DescribeAppServiceDetail	list	全部资源 *	无	无

请求语法

GET /pop/v1/sam/service/describeAppServiceDetail

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。	6dcc8c9e-d3da-478a-a066-86dcf820****
ServiceType	string	否	服务类型。取值说明如下： dubbo springCloud	springCloud
ServiceGroup	string	否	服务分组。自定义。	springCloud
ServiceVersion	string	否	服务版本。自定义。	1.0.0
ServiceName	string	否	服务名称。	edas.service.provider

返回参数

名称	类型	描述	示例值
	object	返回数据。
RequestId	string	请求 ID。	B2C7874F-F109-5B34-8618-2C10BBA2****
Message	string	调用结果的附加信息。	success
TraceId	string	调用链 ID，用于精确查询调用信息。	0b16399316402420740034918e****
Data	object	返回数据。
Group	string	服务分组。自定义。	springCloud
ServiceName	string	服务名称。	service-provider
Version	string	服务版本。自定义。	1.0.0
ServiceType	string	服务类型。取值说明如下： dubbo springCloud	springCloud
EdasAppName	string	应用名称。	cn-zhangjiakou-micro-service-******
Metadata	object	元数据。示例如下：`{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}`	{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…}
SpringApplicationName	string	Spring Cloud 应用名称。	service-provider
DubboApplicationName	string	Dubbo 应用名称。	service-consumer
Methods	array<object>	方法列表。
	object	方法列表。
MethodController	string	所属类。	com.serverless.sae.controller.EchoController
ReturnType	string	返回类型。	java.lang.String
ReturnDetails	string	返回详情。	test
Name	string	方法名。	echo
NameDetail	string	方法详情。	description
ParameterDetails	array	参数详情。
	string	参数详情。	description
RequestMethods	array	请求方法。
	string	请求方法。取值说明如下： GET ALL	ALL
ParameterTypes	array	参数类型。
	string	参数类型。	["java.lang.String"]
Paths	array	请求路径。
	string	请求路径。格式如下： `/path`	["/echo/{str}"]
ParameterDefinitions	array<object>	参数定义。
	object	参数定义。
Type	string	参数类型。	java.lang.String
Description	string	参数描述。	description
Name	string	参数名称。	arg0
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码列表。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	是否成功获取元数据。取值说明如下： true：获取成功。 false：获取失败。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "B2C7874F-F109-5B34-8618-2C10BBA2****",
  "Message": "success",
  "TraceId": "0b16399316402420740034918e****",
  "Data": {
    "Group": "springCloud",
    "ServiceName": "service-provider",
    "Version": "1.0.0",
    "ServiceType": "springCloud",
    "ServiceProtocol": "",
    "ServicePorts": [
      0
    ],
    "ServiceTags": [
      ""
    ],
    "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
}

错误码

HTTP status code	错误码	错误信息	描述
400	Micro.Service.MetaData.NotFound	The micro service metadata not found {%s}.	微服务原信息不存在
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.	不合法的参数{%s}。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-20	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情