QueryClusterInfo - Microservices Engine - Alibaba Cloud Documentation Center

Queries the static information of 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 support 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	Cluster ID.	mse-09k1q11****
InstanceId	string	No	Instance ID.	mse_prepaid_public_cn-7mz2t63ci03
OrderId	string	No	Order ID.	20574710974****
AclSwitch	boolean	No	Specifies whether to query the public network whitelist configuration.	false
RegionId	string	No	Region ID.	cn-hangzhou
RequestPars	string	No	Extended request parameters in JSON format.	{}
AcceptLanguage	string	No	The language type of the returned information: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	Data structure.
Message	string	Response message. When the request is successful, it returns a success message. When the request fails, it returns the reason for the failure.	The request is successfully processed.
RequestId	string	Request ID.	415088B3-A7BE-56F6-9CD9-C42DE895CD41
Data	object	Data overview.
VpcId	string	The VPC ID where the cluster is located.	vpc-bp1v5nbauzh8xxxxxxx
CreateTime	string	Cluster creation time.	2022-12-15 10:02:07
IntranetAddress	string	Reserved field.	null
DiskType	string	Deprecated field.	null
PubNetworkFlow	string	Public bandwidth in Mbps. Valid values: 0 to 5000. The value 0 indicates that the cluster is not connected to the Internet.	1
DiskCapacity	integer	Deprecated field.	null
MemoryCapacity	integer	Deprecated field.	null
ClusterAliasName	string	Cluster alias.	Development environment
InstanceCount	integer	Number of cluster instances.	3
IntranetPort	string	Open ports for the internal network of the cluster.	8848,6443,9848,8761
InstanceModels	array	Reserved structure.
	object	Reserved structure.
PodName	string	Reserved field.	null
SingleTunnelVip	string	Reserved field.	null
InternetIp	string	Reserved field.	null
Ip	string	Reserved field.	null
Role	string	Reserved field.	null
HealthStatus	string	Reserved field.	null
CreationTimestamp	string	Reserved field.	null
Zone	string	Reserved field.	null
IntranetDomain	string	Internal same-region endpoint.	mse-xxxxx-nacos-ans.mse.aliyuncs.com
InternetDomain	string	Public domain name.	mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com
PayInfo	string	Billing method.	Pay-as-you-go
InternetAddress	string	Reserved field.	null
InstanceId	string	Instance	mse-cn-st21ri2****
AclEntryList	string	Public network whitelist.	["127.0.0.0/32"]
HealthStatus	string	Cluster status.	INIT_SUCCESS
InitCostTime	integer	Time taken for cluster initialization (in milliseconds).	53353
RegionId	string	Region ID.	cn-hangzhou
AclId	string	Public network whitelist instance ID	acl-bp144q24cgqvzckmxxxx
Cpu	integer	Deprecated field.	null
ClusterType	string	Cluster type, including ZooKeeper, Nacos-Ans, and Eureka.	Nacos-Ans
ClusterName	string	Full cluster name.	mse-74355150-xxxxxxx
InitStatus	string	Initialization status.	INIT_SUCCESS
InternetPort	string	Open ports for the public network of the cluster.	8848,6443,9848,8761
AppVersion	string	Cluster version number.	2.1.0
NetType	string	Cluster network connectivity type.	privatenet
ClusterVersion	string	Order version.	NACOS_2_0_0
ClusterSpecification	string	DPI engine specification.	MSE_SC_2_4_60_c
VSwitchId	string	vSwitch ID.	vsw-bp1egfakxxxxx
ConnectionType	string	Deprecated field.	null
MseVersion	string	Cluster version.	mse_pro
ChargeType	string	Payment mode, including subscription and pay-as-you-go.	POSTPAY
Tags	object	Tags.
ExpectZones	array	List of zones where the current cluster can be distributed.
	string	Zone ID.	cn-hangzhou-k
MaintenancePeriod	object	O&M time window
EndTime	string	O&M time window start time	02:00
StartTime	string	O&M time window end time	06:00
EndDate	string	Expiration time (subscription)	2021-08-01 00:00:00
SecurityGroupId	string	Security group ID for Elastic Network Interface network access	sg-uf6hgwe067prhg68agfa
SecurityGroupType	string	Security group type for Elastic Network Interface network access	enterprise
EipInstanceId	string	Instance ID of the Elastic IP Address (EIP)	eip-bp1uujshd5funmyy8rcl9
CanUpdate	boolean	Indicates whether the cluster has a minor version available for upgrade
VersionCode	string	Current version code of the cluster
VersionLifecycle	string
ErrorCode	string	Error code.	mse-100-000
Success	boolean	Request result, with the following values: `true`: The request is successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "Message": "The request is successfully processed.\n",
  "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": "Development environment\n",
    "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": "Pay-as-you-go\n",
    "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": "",
    "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.