GetApplicationInstanceList API リファレンス - MSE

マイクロサービスアプリケーションインスタンスのリストを照会します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Namespace	string	任意	アプリケーションが属する Microservices Engine (MSE) の名前空間。	default
AppName	string	任意	アプリケーション名。	example-app
AppId `deprecated`	string	任意	アプリケーション ID。	abcde@12345
Tag	string	任意	ノードに追加するタグ。	gray
PageNumber	integer	必須	ページ番号。ページは 1 から始まります。	1
PageSize	integer	必須	1 ページあたりのエントリ数。	20
Region	string	任意	リージョン。	cn-hangzhou
AcceptLanguage	string	任意	結果を表示する言語。有効な値： zh および en。zh は中国語 (デフォルト値)、en は英語を示します。	zh

レスポンスフィールド

フィールド	型	説明	例
	object
Data	object	返されたデータ。
Result	array<object>	照会されたノード。
	array<object>
Ip	string	ノードの IP アドレス。	10.1.2.3
Tags	array<object>	ノードのタグ。
	object
Tag	string	タグ値。	gray
Port	string	アプリケーションのポート。	8080
TotalSize	integer	ノードの総数。	100
PageNumber	integer	ページ番号。ページは 1 から始まります。	1
PageSize	integer	1 ページあたりのエントリ数。	10

例

成功レスポンス

JSONJSON

{
  "Data": {
    "Result": [
      {
        "Ip": "10.1.2.3",
        "Tags": [
          {
            "Tag": "gray"
          }
        ],
        "Port": "8080"
      }
    ],
    "TotalSize": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

エラーコード

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

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

変更履歴

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