獲取應用服務的元數據詳情。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| sae:DescribeAppServiceDetail | list | *全部資源 * |
| 無 |
請求語法
GET /pop/v1/sam/service/describeAppServiceDetail HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 返回結構發生變更 | 查看變更詳情 |