ListEurekaInstances - Microservices Engine - Alibaba Cloud ドキュメントセンター

Eureka インスタンスを照会します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RequestPars	string	任意	JSON フォーマットの拡張リクエストパラメーター。	{}
PageNum	integer	必須	返すページの番号。	1
PageSize	integer	必須	各ページで返すエントリの数。	10
ClusterId	string	任意	インスタンスの ID。	mse-09k1q11****
ServiceName	string	必須	サービスの名前。	name
AcceptLanguage	string	任意	応答の言語。有効な値: zh: 中国語 en: 英語。	zh

レスポンスフィールド

フィールド	型	説明	例
	object	The data structure.
HttpCode	string	The HTTP status code returned.	202
TotalCount	integer	The total number of returned instances.	7
RequestId	string	The ID of the request.	316F5F64-F73D-42DC-8632-01E308B6****
Message	string	The message returned.	The request is successfully processed.
PageSize	integer	The number of entries returned per page.	10
PageNumber	integer	The page number of the returned page.	1
Data	array<object>	The details of the data.
	array<object>	The data structure.
Status	string	The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.	1/1
LastDirtyTimestamp	integer	The time when the instance was last modified.	20201009115543
IpAddr	string	The IP address.	30.5.XX.XX
HomePageUrl	string	The URL of the homepage.	http://30.5.XX.XX:8091/
HostName	string	The hostname.	30.5.XX.XX
InstanceId	string	The ID of the instance.	L-PC1A6A28-****.hz.ali.com:contactinfo:8091
Port	integer	The service port number.	8091
SecurePort	integer	The security port.	443
App	string	The name of the application.	CONTACTINFO
DurationInSecs	integer	The timeout period of the instance. After the specified timeout period expires, the service is unavailable by default and is deleted.	90
LastUpdatedTimestamp	integer	The time when the instance heartbeat was last checked.	20201010071203
RenewalIntervalInSecs	integer	The maximum interval between two heartbeat checks after a heartbeat check times out. Default value: 10.	10
VipAddress	string	The virtual IP address (VIP).	contactinfo
Metadata	object	The metadata.	[string]
ErrorCode	string	The error code returned if the request failed.	mse-100-000
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true

例

成功レスポンス

JSONJSON

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Message": "The request is successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "Status": "1/1",
      "LastDirtyTimestamp": 20201009115543,
      "IpAddr": "30.5.XX.XX",
      "HomePageUrl": "http://30.5.XX.XX:8091/",
      "HostName": "30.5.XX.XX",
      "InstanceId": "L-PC1A6A28-****.hz.ali.com:contactinfo:8091",
      "Port": 8091,
      "SecurePort": 443,
      "App": "CONTACTINFO",
      "DurationInSecs": 90,
      "LastUpdatedTimestamp": 20201010071203,
      "RenewalIntervalInSecs": 10,
      "VipAddress": "contactinfo",
      "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

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

変更履歴

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