查詢Nacos服務的叢集列表。
介面說明
當前的 OpenAPI 並非是 Nacos-SDK API,Nacos-SDK API 相關內容,請參見官方文檔。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| PageNum |
integer |
是 |
頁碼。 |
1 |
| PageSize |
integer |
是 |
每頁展示執行個體數。 |
10 |
ClusterId
deprecated
|
string |
否 |
MSE 叢集 ID。 說明
此處的叢集與 nacos 服務下的叢集概念不同,勿混淆。 |
mse-09k1xxxx |
| ServiceName |
string |
否 |
服務名稱。 |
nacos.test.3 |
| GroupName |
string |
否 |
分組名稱,預設為 DEFAULT_GROUP |
DEFAULT_GROUP |
| NamespaceId |
string |
否 |
命名空間 ID,預設為 public |
12233**** |
| ClusterName |
string |
否 |
nacos 服務叢集名 |
qewr |
| InstanceId |
string |
否 |
執行個體 ID。 |
mse_prepaid_public_cn-tl32a6**** |
| AcceptLanguage |
string |
否 |
返回資訊的語言類型:
|
zh |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
資料結構。 |
||
| Message |
string |
資訊。 |
The request is successfully processed. |
| RequestId |
string |
請求 ID。 |
52BA6DA6-A702-4362-A32F-DFF79655**** |
| Data |
object |
資料概覽。 |
|
| ProtectThreshold |
number |
保護閾值。 |
0 |
| GroupName |
string |
服務所屬服務組。 |
DEFAULT_GROUP |
| Clusters |
array<object> |
叢集資訊。 |
|
|
array<object> |
資料結構。 |
||
| DefaultCheckPort |
integer |
預設檢查連接埠。 |
80 |
| HealthCheckerType |
string |
健全狀態檢查類型。 |
tcp |
| UseIPPort4Check |
boolean |
服務端是否主動發起端到端健康狀態檢查,當服務為非臨時服務時此值有效。 |
true |
| ServiceName |
string |
全量服務名。 |
DEFAULT_GROUP@@nacos.test.3 |
| Name |
string |
叢集名稱。 |
test |
| DefaultPort |
integer |
預設連接埠。 |
80 |
| Metadata |
object |
叢集中繼資料。 |
111 |
| Name |
string |
服務名稱。 |
nacos.test.3 |
| SelectorType |
string |
選舉模式。 |
none |
| Metadata |
object |
服務中繼資料。 |
111 |
| Ephemeral |
boolean |
是否臨時節點,取值如下:
|
true |
| Source |
string |
服務類型,取值如下:
|
console |
| AppDetail |
object |
服務類型為服務治理註冊時,服務所關聯的服務治理應用資訊。 |
|
| AppId |
string |
服務治理應用 id。 |
hkhon1po62@904cba2c0xxxxxx |
| AppName |
string |
服務治理應用程式名稱。 |
spring-cloud-b |
| Port |
integer |
服務治理應用連接埠。 |
6001 |
| CheckType |
string |
健全狀態檢查協議,取值如下:
|
tcp |
| CheckPath |
string |
健全狀態檢查路徑(健全狀態檢查類型為 http 時攜帶)。 |
/health |
| CheckTimeout |
integer |
健全狀態檢查響應逾時時間,單位:秒。 |
5 |
| CheckInternal |
integer |
健全狀態檢查間隔,單位:秒。 |
2 |
| HealthyCheckTimes |
integer |
健全狀態檢查健康閾值,指執行個體從不健康變為健康過程中健康探測重試次數。 |
2 |
| UnhealthyCheckTimes |
integer |
健全狀態檢查不健康閾值,指執行個體從健康變為不健康過程中健康探測重試次數。 |
2 |
| ErrorCode |
string |
錯誤碼。 |
mse-100-000 |
| Success |
boolean |
請求結果,取值如下:
|
true |
| HttpCode |
string |
HTTP 狀態代碼。 |
200 |
樣本
正常返回樣本
JSON格式
{
"Message": "The request is successfully processed.",
"RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
"Data": {
"ProtectThreshold": 0,
"GroupName": "DEFAULT_GROUP",
"Clusters": [
{
"DefaultCheckPort": 80,
"HealthCheckerType": "tcp",
"UseIPPort4Check": true,
"ServiceName": "DEFAULT_GROUP@@nacos.test.3",
"Name": "test",
"DefaultPort": 80,
"Metadata": 111
}
],
"Name": "nacos.test.3",
"SelectorType": "none",
"Metadata": 111,
"Ephemeral": true,
"Source": "console",
"AppDetail": {
"AppId": "hkhon1po62@904cba2c0xxxxxx",
"AppName": "spring-cloud-b",
"Port": 6001,
"CheckType": "tcp",
"CheckPath": "/health",
"CheckTimeout": 5,
"CheckInternal": 2,
"HealthyCheckTimes": 2,
"UnhealthyCheckTimes": 2
}
},
"ErrorCode": "mse-100-000",
"Success": true,
"HttpCode": "200"
}
錯誤碼
|
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 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。