ListEurekaInstances API Reference - Microservices Engine - Alibaba Cloud - Microservices Engine

Queries Eureka instances.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:ListEurekaInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	The extended request parameters in the JSON format.	{}
PageNum	integer	Yes	The number of the page to return.	1
PageSize	integer	Yes	The number of entries to return on each page.	10
ClusterId	string	No	The ID of the instance.	mse-09k1q11****
ServiceName	string	Yes	The name of the service.	name
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	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

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.