获取应用服务的元数据详情。
调试
您可以在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 | 否 | 服务类型。取值说明如下:
| springCloud |
ServiceGroup | string | 否 | 服务分组。自定义。 | springCloud |
ServiceVersion | string | 否 | 服务版本。自定义。 | 1.0.0 |
ServiceName | string | 否 | 服务名称。 | edas.service.provider |
NacosInstanceId | string | 否 | MseNacos 实例 ID。 | mse-cn-sco3r0u**** |
NacosNamespaceId | string | 否 | MseNacos 命名空间 ID。 | public |
返回参数
示例
正常返回示例
JSON
格式
{
"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
}
错误码
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 返回结构发生变更 | 查看变更详情 |