ListAnsServiceClusters API Reference for Nacos Service Clusters - MSE - Alibaba Cloud - Microservices Engine

Queries the clusters of a Nacos service.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
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 `deprecated`	string	No	The ID of the MSE cluster. Note The MSE cluster is different from the cluster of the Nacos service.	mse-09k1xxxx
ServiceName	string	No	The name of the service.	nacos.test.3
GroupName	string	No	The name of the group.	DEFAULT_GROUP
NamespaceId	string	No	The ID of the namespace.	12233****
ClusterName	string	No	The alias of the cluster.	qewr
InstanceId	string	No	The ID of the instance.	mse_prepaid_public_cn-tl32a6****
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The message returned.	The request is successfully processed.
RequestId	string	The ID of the request.	52BA6DA6-A702-4362-A32F-DFF79655****
Data	object	The data returned.
ProtectThreshold	number	The protection threshold.	0
GroupName	string	The service group to which the service belongs.	DEFAULT_GROUP
Clusters	array<object>	The cluster information.
	array<object>	The data structure.
DefaultCheckPort	integer	The default port used for a health check.	80
HealthCheckerType	string	The type of the health check.	tcp
UseIPPort4Check	boolean	Indicates whether an end-to-end health check was initiated by the server. This parameter is valid only if the service is not a temporary service.	true
ServiceName	string	The full name of the service.	DEFAULT_GROUP@@nacos.test.3
Name	string	The cluster name.	test
DefaultPort	integer	The default port.	80
Metadata	object	The metadata of the cluster.	111
Name	string	The name of the service.	nacos.test.3
SelectorType	string	The election mode.	none
Metadata	object	The metadata of the service.	111
Ephemeral	boolean	Indicates whether the service is a temporary service. Valid values: `true`: yes `false`: no	true
Source	string	The source type of the service. Valid values: console: The service was registered in the console. sdk: The service was registered by using the SDK. governance: The service was registered on Microservices Governance.	console
AppDetail	object	The information about the associated application for which Microservices Governance is enabled when the Source parameter is set to governance.
AppId	string	The ID of the application for which Microservices Governance is enabled.	hkhon1po62@904cba2c0xxxxxx
AppName	string	The name of the application for which Microservices Governance is enabled.	spring-cloud-b
Port	integer	The port number of the application for which Microservices Governance is enabled.	6001
CheckType	string	The type of the health check. Valid values: connection: connection status check tcp: TCP connection check http: HTTP connection check	tcp
CheckPath	string	The path of the health check. This parameter is required only when the CheckType parameter is set to http.	/health
CheckTimeout	integer	The timeout period of the health check response. Unit: seconds.	5
CheckInternal	integer	The health check interval. Unit: seconds.	2
HealthyCheckTimes	integer	The maximum number of health check retries when the instance state changes from unhealthy to healthy.	2
UnhealthyCheckTimes	integer	The maximum number of health check retries when the instance state changes from healthy to unhealthy.	2
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
HttpCode	string	The HTTP status code.	200

Examples

Success response

JSON format

{
  "Message": "The request is successfully processed.",
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Data": {
    "ProtectThreshold": 0,
    "GroupName": "DEFAULT_GROUP",
    "Clusters": [
      {
        "DefaultCheckPort": 80,
        "HealthCheckerType": "tcp",
        "UseIPPort4Check": true,
        "ServiceName": "DEFAULT_GROUP@@nacos.test.3",
        "Name": "test",
        "DefaultPort": 80,
        "Metadata": 111
      }
    ],
    "Name": "nacos.test.3",
    "SelectorType": "none",
    "Metadata": 111,
    "Ephemeral": true,
    "Source": "console",
    "AppDetail": {
      "AppId": "hkhon1po62@904cba2c0xxxxxx",
      "AppName": "spring-cloud-b",
      "Port": 6001,
      "CheckType": "tcp",
      "CheckPath": "/health",
      "CheckTimeout": 5,
      "CheckInternal": 2,
      "HealthyCheckTimes": 2,
      "UnhealthyCheckTimes": 2
    }
  },
  "ErrorCode": "mse-100-000",
  "Success": true,
  "HttpCode": "200"
}

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.