すべてのプロダクト
Search
ドキュメントセンター

Microservices Engine:ListAnsInstances

最終更新日:Dec 16, 2025

Microservices Engine (MSE) の Nacos インスタンスに登録されているアプリケーションインスタンスを照会します。

操作説明

説明

この操作は Nacos SDK では提供されていません。 Nacos SDK の詳細については、公式ドキュメントをご参照ください。

今すぐお試しください

この 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:ListAnsInstances

list

*All Resource

*

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RequestPars

string

任意

JSON フォーマットの拡張リクエストパラメーター。

{}

PageNum

integer

必須

返すページの番号。

1

PageSize

integer

必須

各ページに返すエントリ数。

10

ClusterId deprecated

string

任意

Nacos インスタンスの ID。

説明

この操作には InstanceId パラメーターと ClusterId パラメーターの両方が含まれます。 いずれか 1 つを指定する必要があります。

mse-09k1q11****

ServiceName

string

必須

サービスの名前。

name

GroupName

string

任意

連絡先グループの名前。

test

NamespaceId

string

任意

名前空間の ID。

12233****

ClusterName

string

任意

Nacos インスタンスのエイリアス。

mse-7413****

InstanceId

string

任意

インスタンスの ID。

説明

この操作には InstanceId パラメーターと ClusterId パラメーターの両方が含まれます。 いずれか 1 つを指定する必要があります。

mse_prepaid_public_cn-tl327w****

AcceptLanguage

string

任意

応答の言語。 有効な値:

  • zh: 中国語

  • en: 英語

zh

レスポンスフィールド

フィールド

説明

object

HttpCode

string

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

202

TotalCount

integer

返されたインスタンスの総数。

7

RequestId

string

リクエストの ID。

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

Message

string

返されたメッセージ。

The request was successfully processed.

PageSize

integer

ページあたりに返されるエントリ数。

10

PageNumber

integer

返すページの番号。

1

Data

array<object>

データの詳細。

array<object>

DefaultKey

string

デフォルトのキー。

30.5.XX.XX:unknown

Ephemeral

boolean

エフェメラルノードに関する情報が取得されたかどうかを示します。 有効な値:

  • true: はい

  • false: いいえ

true

Marked

boolean

インスタンスがマークされたかどうかを示します。 有効な値:

  • true: インスタンスのマーキングは成功しました。

  • false: インスタンスのマーキングは失敗しました。

true

Ip

string

パブリック IP アドレス。

30.5.XX.XX

InstanceId

string

インスタンスの ID。

30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService

Port

integer

ポート番号。

8080

LastBeat

integer

最後のハートビート時間。

20201010

OkCount

integer

カウントされた成功数。

0

Weight

integer

重み。

1

InstanceHeartBeatInterval

integer

インスタンスのハートビート間隔。 単位:秒。

5000

IpDeleteTimeout

integer

IP アドレスを削除するためのタイムアウト期間。

30000

App

string

アプリケーションの名前。

app

FailCount

integer

カウントされた失敗数。

0

Healthy

boolean

インスタンスのヘルスステータス。 有効な値:

  • true: インスタンスは正常です。

  • false: インスタンスは異常です。

true

Enabled

boolean

インスタンスの有効ステータス。 有効な値:

  • true: インスタンスは有効です。

  • false: インスタンスは無効です。

true

DatumKey

string

参照キー。

30.5.XX.XX:unknown:DEFAULT

ClusterName

string

クラスターの名前。

DEFAULT

InstanceHeartBeatTimeOut

integer

インスタンスのハートビートのタイムアウト期間。

15000

ServiceName

string

サービス名。

DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::

Metadata

object

メタデータ。

[int]

ErrorCode

string

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

mse-100-000

Success

boolean

リクエストが成功したかどうかを示します。有効な値は次のとおりです。

  • true:リクエストが成功したことを示します。

  • false:リクエストが失敗したことを示します。

true

成功レスポンス

JSONJSON

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "DefaultKey": "30.5.XX.XX:unknown",
      "Ephemeral": true,
      "Marked": true,
      "Ip": "30.5.XX.XX",
      "InstanceId": "30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService",
      "Port": 8080,
      "LastBeat": 20201010,
      "OkCount": 0,
      "Weight": 1,
      "InstanceHeartBeatInterval": 5000,
      "IpDeleteTimeout": 30000,
      "App": "app",
      "FailCount": 0,
      "Healthy": true,
      "Enabled": true,
      "DatumKey": "30.5.XX.XX:unknown:DEFAULT",
      "ClusterName": "DEFAULT",
      "InstanceHeartBeatTimeOut": 15000,
      "ServiceName": "DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::",
      "Metadata": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

エラーコード

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

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

変更履歴

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