ListInstanceCount - Microservices Engine - Alibaba Cloud Documentation Center

Displays the number of nodes that can be deployed for an instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
mse:ListInstanceCount	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterType	string	No	The type of the instance. Valid values: ZooKeeper and Nacos-Ans.	Nacos-Ans
MseVersion	string	No	The edition type of the instance. Valid values: `mse_dev`: Developer Edition `mse_pro`: Professional Edition	mse_pro
RegionId	string	No	The ID of the region where the instance resides. Examples: cn-hangzhou: China (Hangzhou) cn-beijing: China (Beijing) cn-shanghai: China (Shanghai) cn-zhangjiakou: China (Zhangjiakou) cn-shenzhen: China (Shenzhen)	cn-hangzhou
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 parameters

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The ID of the request.	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Code	integer	The status code. A value of 200 is returned if the request is successful.	200
ErrorCode	string	The error code returned if the request failed. If the request failed, the ErrorCode parameter is returned. For more information, see the Error codes section of this topic.	mse-100-100
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The returned message. If the request is successful, a success message is returned. If the request fails, an error message is returned.	The request was successfully processed.
DynamicCode	string	The dynamic part in the error message.	%s
DynamicMessage	string	The dynamic part in the error message. This parameter is used to replace `%s` in the `ErrMessage` parameter. Note If the return value of the `ErrMessage` parameter is `The Value of Input Parameter %s is not valid` and the return value of the `DynamicMessage` parameter is `DtsJobId`, the specified `DtsJobId` parameter is invalid.	The specified parameter is invalid.
Data	array	The data entries returned.
Data	integer	The number of nodes that can be deployed for the instance of the current edition.	3

Examples

Sample success responses

JSONformat

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-100",
  "HttpStatusCode": 200,
  "Message": "The request was successfully processed.\n",
  "DynamicCode": "%s",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": [
    3
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	duplicatedClusterAliasName	duplicated cluster alias name	The instance name is duplicate. User another name.
400	illegalRequest	illegal request:%s	Invalid request: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	clusterNotFound	cluster not found	The cluster is not found.
500	systemError	system error	An error occurred on the system. Try again later.

For a list of error codes, visit the Service error codes.