Query Nacos Registered Instances with ListAnsInstances for Service Discovery - MSE - Alibaba Cloud - Microservices Engine

Queries the application instances registered with an MSE Nacos instance.

Operation description

Note

The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RequestPars	string	No	Extended request parameters in JSON format.	{}
PageNum	integer	Yes	The page number to return.	1
PageSize	integer	Yes	The number of entries per page.	10
ClusterId `deprecated`	string	No	The ID of the Nacos instance. Note You must specify either InstanceId or ClusterId.	mse-09k1q11****
ServiceName	string	Yes	The name of the service.	name
GroupName	string	No	The name of the group.	test
NamespaceId	string	No	The ID of the namespace.	12233****
ClusterName	string	No	The alias of the Nacos instance.	mse-7413****
InstanceId	string	No	The ID of the instance. Note You must specify either InstanceId or ClusterId.	mse_prepaid_public_cn-tl327w****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object
HttpCode	string	The HTTP status code.	202
TotalCount	integer	The total number of instances.	7
RequestId	string	The ID of the request.	52BA6DA6-A702-4362-A32F-DFF79655****
Message	string	The response message.	The request was successfully processed.
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Data	array<object>	The returned data.
	array<object>
DefaultKey	string	The default key.	30.5.XX.XX:unknown
Ephemeral	boolean	Indicates whether the information about the ephemeral node is obtained. Valid values: `true`: yes `false`: no	true
Marked	boolean	Indicates whether the instance is marked. Valid values: `true`: The instance marking was successful. `false`: The instance marking failed.	true
Ip	string	The public IP address.	30.5.XX.XX
InstanceId	string	The ID of the instance.	30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService
Port	integer	The port number.	8080
LastBeat	integer	The last heartbeat timestamp.	20201010
OkCount	integer	The number of counted successes.	0
Weight	integer	The weight of the instance.	1
InstanceHeartBeatInterval	integer	The heartbeat interval of the instance. Unit: seconds.	5000
IpDeleteTimeout	integer	The timeout period for removing an IP address. Unit: milliseconds.	30000
App	string	The name of the application.	app
FailCount	integer	The number of counted failures.	0
Healthy	boolean	The health status of the instance. Valid values: `true`: The instance is healthy. `false`: The instance is unhealthy.	true
Enabled	boolean	The effective status of the instance. Valid values: `true`: The instance takes effect. `false`: The instance does not take effect.	true
DatumKey	string	The reference key.	30.5.XX.XX:unknown:DEFAULT
ClusterName	string	The name of the cluster.	DEFAULT
InstanceHeartBeatTimeOut	integer	The heartbeat timeout of the instance. Unit: milliseconds.	15000
ServiceName	string	The name of the service.	DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::
Metadata	object	The instance metadata.	[int]
ErrorCode	string	The error code. This parameter is returned only 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": "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
}

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.