すべてのプロダクト
Search

このプロダクト

    Microservices Engine:GetServiceListeners

    ドキュメントセンター

    Microservices Engine:GetServiceListeners

    最終更新日:Dec 16, 2025

    宛先サービスのリスナーのリストを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mse:GetServiceListeners

    get

    *Cluster

    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}

    *EngineNamespace

    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}/{#NamespaceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ServiceName

    string

    必須

    照会するリスナーが属するサービスの名前。

    zeekr-orderboss
    GroupName

    string

    必須

    サービスが属するグループ。

    WEB_GROUP
    NamespaceId

    string

    必須

    サービスが属する名前空間。

    ddaf8f12-****-b1c1-86e7c72e266b
    ClusterName

    string

    任意

    サービスが属するクラスターの名前。

    説明

    クラスターは Nacos サービスの概念であり、Microservices Engine (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：中国語

    • en：英語

    zh

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    データ構造。

    Data

    array<object>

    返されたデータ。

    object

    データの詳細。

    Addr

    string

    リスナーの IP アドレス。

    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：リクエストは成功しました。

    • false：リクエストは失敗しました。

    true
    Message

    string

    返されたメッセージ。

    • リクエストが成功した場合、成功メッセージが返されます。

    • リクエストが失敗した場合、エラーメッセージが返されます。

    success
    RequestId

    string

    リクエスト ID。

    54973C90-F379-4372-9AA5-053A3F7****
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコード。

    mse-100-000
    HttpCode

    string

    返された HTTP ステータスコード。

    202

    例

    成功レスポンス

    JSONJSON

    {
  "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 ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 IllegalRequest Invalid request:%s
    400 InvalidParameter Parameter error:%s
    500 InternalError Console error. Try again later:%s
    403 NoPermission You are not authorized to perform this operation:%s
    404 NotFound Not found:%s

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。