ListAnsServices - Microservices Engine - Alibaba Cloud Documentation Center

Queries the details of Nacos services.

Operation description

Note

This OpenAPI is not a Nacos SDK API. For more information about Nacos SDK APIs, 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:ListAnsServices

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceName	string	No	The name of the service.	name
GroupName	string	No	The name of the contact group.	name
NamespaceId	string	No	The ID of the namespace.	12233****
ClusterName	string	No	The parameter that is required to query the list of instances in a specific cluster of a service.
HasIpCount	string	No	Specifies whether to query the number of service instances.	true
ClusterId `deprecated`	string	No	The ID of the cluster. Note You must specify either this parameter or InstanceId.	mse-09k1q11****
InstanceId	string	No	The ID of the instance. Note You must specify either this parameter or ClusterId.	mse-cn-st21v5****
PageNum	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of instances to display on each page.	10
RegionId	string	No	The region.
RequestPars	string	No	The extended request parameters in the JSON format.	{}
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
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 message returned.	The request was successfully processed.
PageSize	integer	The number of instances displayed per page.	10
PageNumber	integer	The page number.	1
Data	array<object>	The data overview.
	object	The data structure.
HealthyInstanceCount	integer	The total number of service instances with healthy heartbeats.	1
GroupName	string	The name of the contact group.	name
IpCount	integer	The total number of instances of the current service.	1
Name	string	The name of the service.	name
ClusterCount	integer	The total number of clusters.	1
Source	string	The type of the service. Valid values: console: registered on the console. sdk: registered using an SDK. governance: registered using service administration.
ErrorCode	string	The error code.	mse-100-000
Success	boolean	The result of the request. 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": [
    {
      "HealthyInstanceCount": 1,
      "GroupName": "name",
      "IpCount": 1,
      "Name": "name",
      "ClusterCount": 1,
      "Source": ""
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationNotSupport	The current cluster does not support this operation, %s.	The current cluster does not support this operation
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.