擷取應用服務的中繼資料詳情。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
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 |
服務類型。取值說明如下:
|
springCloud |
| ServiceProtocol |
string |
該服務使用的協議。 |
HTTP |
| ServicePorts |
array |
該服務使用的連接埠。 |
|
|
integer |
連接埠值。 |
8000 |
|
| ServiceTags |
array |
該服務的標籤。 |
|
|
string |
該服務的標籤值。 |
tag1 |
|
| EdasAppName |
string |
應用程式名稱。 |
cn-zhangjiakou-micro-service-****** |
| Metadata |
object |
中繼資料。樣本如下: |
{side: "provider", port: "18081", preserved: {register: {source: "SPRING_CLOUD"}},…} |
| SpringApplicationName |
string |
Spring Cloud 應用程式名稱。 |
service-provider |
| DubboApplicationName |
string |
Dubbo 應用程式名稱。 |
service-consumer |
| Methods |
array<object> |
方法列表。 |
|
|
array<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 |
要求方法。取值說明如下:
|
ALL |
|
| ParameterTypes |
array |
參數類型。 |
|
|
string |
參數類型。 |
["java.lang.String"] |
|
| Paths |
array |
請求路徑。 |
|
|
string |
請求路徑。格式如下:
|
["/echo/{str}"] |
|
| ParameterDefinitions |
array<object> |
參數定義。 |
|
|
object |
參數定義。 |
||
| Type |
string |
參數類型。 |
java.lang.String |
| Description |
string |
參數描述。 |
description |
| Name |
string |
參數名稱。 |
arg0 |
| ErrorCode |
string |
錯誤碼。取值說明如下:
|
|
| Code |
string |
介面狀態或 POP 錯誤碼。取值說明如下:
|
200 |
| Success |
boolean |
是否成功擷取中繼資料。取值說明如下:
|
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": "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}。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。