Use QueryClusterInfo to query static information of a cluster - Microservices Engine - Alibaba Cloud - Microservices Engine

Queries the static information about a cluster.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID.	mse-09k1q11****
InstanceId	string	No	The instance ID.	mse_prepaid_public_cn-7mz2t63ci03
OrderId	string	No	The order ID.	20574710974****
AclSwitch	boolean	No	Indicates whether to query the public network whitelist.	false
RegionId	string	No	The region ID.	cn-hangzhou
RequestPars	string	No	The extended request parameters in JSON format.	{}
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 of the response.
Message	string	The response message. A success message is returned for a successful request. An error message is returned for a failed request.	请求处理成功
RequestId	string	The request ID.	415088B3-A7BE-56F6-9CD9-C42DE895CD41
Data	object	The returned data.
VpcId	string	The ID of the VPC that contains the cluster.	vpc-bp1v5nbauzh8xxxxxxx
CreateTime	string	The time the cluster was created.	2022-12-15 10:02:07
IntranetAddress	string	This parameter is reserved.	null
DiskType	string	This parameter is deprecated.	null
PubNetworkFlow	string	The public bandwidth in Mbps. Valid values: 0 to 5000. A value of 0 indicates that the public endpoint is disabled.	1
DiskCapacity	integer	This parameter is deprecated.	null
MemoryCapacity	integer	This parameter is deprecated.	null
ClusterAliasName	string	The alias of the cluster.	开发环境
InstanceCount	integer	The number of instances in the cluster.	3
IntranetPort	string	The ports that are open on the cluster's internal network.	8848,6443,9848,8761
InstanceModels	array<object>	This parameter is reserved.
	object	This parameter is reserved.
PodName	string	This parameter is reserved.	null
SingleTunnelVip	string	This parameter is reserved.	null
InternetIp	string	This parameter is reserved.	null
Ip	string	This parameter is reserved.	null
Role	string	This parameter is reserved.	null
HealthStatus	string	This parameter is reserved.	null
CreationTimestamp	string	This parameter is reserved.	null
Zone	string	This parameter is reserved.	null
IntranetDomain	string	The cluster's internal domain name.	mse-xxxxx-nacos-ans.mse.aliyuncs.com
InternetDomain	string	The cluster's public domain name.	mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com
PayInfo	string	The billing method.	按量付费
InternetAddress	string	This parameter is reserved.	null
InstanceId	string	The instance ID.	mse-cn-st21ri2****
AclEntryList	string	The IP whitelist for public access.	["127.0.0.0/32"]
HealthStatus	string	The health status of the cluster.	INIT_SUCCESS
InitCostTime	integer	The time taken to initialize the cluster, in milliseconds.	53353
RegionId	string	The region ID.	cn-hangzhou
AclId	string	The ID of the public access IP whitelist.	acl-bp144q24cgqvzckmxxxx
Cpu	integer	This parameter is deprecated.	null
ClusterType	string	The type of the cluster. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.	Nacos-Ans
ClusterName	string	The cluster's full name.	mse-74355150-xxxxxxx
InitStatus	string	The initialization status of the cluster.	INIT_SUCCESS
InternetPort	string	The ports that are open on the cluster's public network.	8848,6443,9848,8761
AppVersion	string	The cluster version.	2.1.0
NetType	string	The cluster's network connection type.	privatenet
ClusterVersion	string	The cluster edition.	NACOS_2_0_0
ClusterSpecification	string	The cluster's engine specification.	MSE_SC_2_4_60_c
VSwitchId	string	The ID of the vSwitch.	vsw-bp1egfakxxxxx
ConnectionType	string	This parameter is deprecated.	null
MseVersion	string	The edition of the MSE instance.	mse_pro
ChargeType	string	The cluster's billing method. Valid values: `PREPAY` (subscription) and `POSTPAY` (pay-as-you-go).	POSTPAY
Tags	object	The tags attached to the cluster.
ExpectZones	array	A list of availability zones in which the cluster can be deployed.
	string	An availability zone ID.	cn-hangzhou-k
MaintenancePeriod	object	The maintenance window.
EndTime	string	The end time of the maintenance window.	02:00
StartTime	string	The start time of the maintenance window.	06:00
EndDate	string	The expiration date of the subscription-based cluster.	2021-08-01 00:00:00
SecurityGroupId	string	The security group ID of the Elastic Network Interface (ENI).	sg-uf6hgwe067prhg68agfa
SecurityGroupType	string	The type of the security group for the ENI.	enterprise
EipInstanceId	string	The instance ID of the Elastic IP Address (EIP).	eip-bp1uujshd5funmyy8rcl9
CanUpdate	boolean	Indicates whether the cluster can be upgraded to a later minor version.	true
VersionCode	string	The current version code of the cluster.	NACOS_2_1_0_1
VersionLifecycle	string	The version lifecycle.
ErrorCode	string	The error code.	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

{
  "Message": "请求处理成功",
  "RequestId": "415088B3-A7BE-56F6-9CD9-C42DE895CD41",
  "Data": {
    "VpcId": "vpc-bp1v5nbauzh8xxxxxxx",
    "CreateTime": "2022-12-15 10:02:07",
    "IntranetAddress": "null",
    "DiskType": "null",
    "PubNetworkFlow": "1",
    "DiskCapacity": 0,
    "MemoryCapacity": 0,
    "ClusterAliasName": "开发环境",
    "InstanceCount": 3,
    "IntranetPort": "8848,6443,9848,8761",
    "InstanceModels": [
      {
        "PodName": "null",
        "SingleTunnelVip": "null",
        "InternetIp": "null",
        "Ip": "null",
        "Role": "null",
        "HealthStatus": "null",
        "CreationTimestamp": "null",
        "Zone": "null"
      }
    ],
    "IntranetDomain": "mse-xxxxx-nacos-ans.mse.aliyuncs.com",
    "InternetDomain": "mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com",
    "PayInfo": "按量付费",
    "InternetAddress": "null",
    "InstanceId": "mse-cn-st21ri2****",
    "AclEntryList": "[\"127.0.0.0/32\"]",
    "HealthStatus": "INIT_SUCCESS",
    "InitCostTime": 53353,
    "RegionId": "cn-hangzhou",
    "AclId": "acl-bp144q24cgqvzckmxxxx",
    "Cpu": 0,
    "ClusterType": "Nacos-Ans",
    "ClusterName": "mse-74355150-xxxxxxx",
    "InitStatus": "INIT_SUCCESS",
    "InternetPort": "8848,6443,9848,8761",
    "AppVersion": "2.1.0",
    "NetType": "privatenet",
    "ClusterVersion": "NACOS_2_0_0",
    "ClusterSpecification": "MSE_SC_2_4_60_c",
    "VSwitchId": "vsw-bp1egfakxxxxx",
    "ConnectionType": "null",
    "MseVersion": "mse_pro",
    "ChargeType": "POSTPAY",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ExpectZones": [
      "cn-hangzhou-k"
    ],
    "MaintenancePeriod": {
      "EndTime": "02:00",
      "StartTime": "06:00"
    },
    "EndDate": "2021-08-01 00:00:00",
    "SecurityGroupId": "sg-uf6hgwe067prhg68agfa",
    "SecurityGroupType": "enterprise",
    "EipInstanceId": "eip-bp1uujshd5funmyy8rcl9",
    "CanUpdate": true,
    "VersionCode": "NACOS_2_1_0_1",
    "VersionLifecycle": ""
  },
  "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.