全部產品
Search

搜尋本產品

    Microservices Engine：ListAnsServices - 查詢Nacos服務詳情

    文件中心

    Microservices Engine：ListAnsServices - 查詢Nacos服務詳情

    更新時間：Aug 05, 2025

    查詢Nacos服務詳情。

    介面說明

    說明

    當前的 OpenAPI 並非是 Nacos-SDK API，Nacos-SDK API 相關內容，請參見官方文檔。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    mse:ListAnsServices

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ServiceName

    string

    否

    服務名稱。

    name
    GroupName

    string

    否

    連絡人群組名稱。

    name
    NamespaceId

    string

    否

    命名空間 ID。

    12233****
    ClusterName

    string

    否

    查詢服務下某個叢集的執行個體列表時所需要的參數。

    DEFAULT
    HasIpCount

    string

    否

    是否查詢服務執行個體數量。

    true
    ClusterId deprecated

    string

    否

    叢集 ID。

    說明

    此介面同時有 InstanceId 與 ClusterId，則其中一項必填。

    mse-09k1q11****
    InstanceId

    string

    否

    執行個體 ID。

    說明

    此介面同時有 InstanceId 與 ClusterId，則其中一項必填。

    mse-cn-st21v5****
    PageNum

    integer

    是

    頁碼。

    1
    PageSize

    integer

    是

    每頁展示執行個體數。

    10
    RegionId

    string

    否

    地區。

    cn-hangzhou
    RequestPars

    string

    否

    擴充請求參數，JSON 格式。

    {}
    AcceptLanguage

    string

    否

    返回資訊的語言類型：

    • zh：中文

    • en：英文

    zh

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    資料結構。

    HttpCode

    string

    HTTP 狀態代碼。

    202
    TotalCount

    integer

    執行個體總數。

    7
    RequestId

    string

    請求 ID。

    52BA6DA6-A702-4362-A32F-DFF79655****
    Message

    string

    資訊。

    請求處理成功
    PageSize

    integer

    每頁展示執行個體數。

    10
    PageNumber

    integer

    頁碼。

    1
    Data

    array<object>

    資料概覽。

    object

    資料結構。

    HealthyInstanceCount

    integer

    健康心跳的服務執行個體總數。

    1
    GroupName

    string

    連絡人群組名稱。

    name
    IpCount

    integer

    當前服務的執行個體總數。

    1
    Name

    string

    服務名稱。

    name
    ClusterCount

    integer

    叢集總數。

    1
    Source

    string

    服務類型，取值如下：

    • console：控制台註冊。

    • sdk：SDK 註冊。

    • governance：服務治理註冊。

    console
    ErrorCode

    string

    錯誤碼。

    mse-100-000
    Success

    boolean

    請求結果，取值如下：

    • true：請求成功。

    • false：請求失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "請求處理成功",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "HealthyInstanceCount": 1,
      "GroupName": "name",
      "IpCount": 1,
      "Name": "name",
      "ClusterCount": 1,
      "Source": "console"
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 OperationNotSupport The current cluster does not support this operation, %s. 當前叢集不支援此操作
    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

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。