擷取目標服務的監聽者列表。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
mse:GetServiceListeners |
get |
*Cluster
*EngineNamespace
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ServiceName |
string |
是 |
查詢指定的服務名資訊。 |
zeekr-orderboss |
| GroupName |
string |
是 |
服務所在的分組。 |
WEB_GROUP |
| NamespaceId |
string |
是 |
服務所在的 namespace。 |
ddaf8f12-****-b1c1-86e7c72e266b |
| ClusterName |
string |
否 |
服務所屬叢集名字。 說明
此處叢集為 nacos 服務中的概念,非 MSE 叢集。 |
DEFAULT |
| HasIpCount |
string |
否 |
保留欄位。 |
none |
ClusterId
deprecated
|
string |
否 |
待查詢服務所屬的 MSE 叢集 ID。 說明
InstanceId 與 ClusterId 其中一個必填。 |
mse-09k1q11**** |
| InstanceId |
string |
否 |
當前查詢服務的叢集 ID。 說明
InstanceId 與 ClusterId 其中一個必填。 |
mse_prepaid_public_cn-tl32odtt20j |
| PageNum |
integer |
否 |
查詢第幾頁。 |
1 |
| PageSize |
integer |
否 |
每頁展示條數。 |
10 |
| RegionId |
string |
否 |
地區 ID。 |
cn-hangzhou |
| RequestPars |
string |
否 |
擴充請求參數,JSON 格式。 |
{} |
| AcceptLanguage |
string |
否 |
返回資訊的語言類型:
|
zh |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
資料結構。 |
||
| Data |
array<object> |
返回結果。 |
|
|
object |
資料概覽。 |
||
| Addr |
string |
監聽者的地址。 |
119.23.84.102 |
| Agent |
string |
監聽者用戶端版本。 |
Nacos-Java-Client:v2.1.1 |
| App |
string |
監聽者的應用程式名稱。 |
app |
| IP |
string |
被監聽服務的 IP 位址。 |
172.16.1.5 |
| Port |
string |
被監聽服務的連接埠號碼。 |
8080 |
| NamespaceId |
string |
命名空間 ID。 |
0ba53825-b183-414f-a6a0-288e4f1c467e |
| ServiceName |
string |
被監聽服務的名稱。 |
zeekr-orderboss |
| Cluster |
string |
被監聽服務所屬叢集名字。 |
DEFAULT |
| PageNumber |
integer |
頁碼。 |
1 |
| TotalCount |
integer |
查詢到的監聽者數量。 |
2 |
| PageSize |
integer |
每頁行數。 |
10 |
| Success |
boolean |
請求結果,取值如下:
|
true |
| Message |
string |
返回資訊。
|
success |
| RequestId |
string |
請求 ID。 |
54973C90-F379-4372-9AA5-053A3F7**** |
| ErrorCode |
string |
錯誤碼。 |
mse-100-000 |
| HttpCode |
string |
HTTP 狀態代碼。 |
202 |
樣本
正常返回樣本
JSON格式
{
"Data": [
{
"Addr": "119.23.84.102",
"Agent": "Nacos-Java-Client:v2.1.1",
"App": "app",
"IP": "172.16.1.5",
"Port": "8080",
"NamespaceId": "0ba53825-b183-414f-a6a0-288e4f1c467e",
"ServiceName": "zeekr-orderboss",
"Cluster": "DEFAULT"
}
],
"PageNumber": 1,
"TotalCount": 2,
"PageSize": 10,
"Success": true,
"Message": "success",
"RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
"ErrorCode": "mse-100-000",
"HttpCode": "202"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | 非法請求: %s |
| 400 | InvalidParameter | Parameter error:%s | 請求參數錯誤:%s |
| 500 | InternalError | Console error. Try again later:%s | 控制台錯誤.稍後重試:%s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | 沒有許可權使用此介面:%s |
| 404 | NotFound | Not found:%s | 資源不存在:%s |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。