QueryClusterDetail-阿里云帮助中心

Queries the details 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 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:QueryClusterDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance.	mse-cn-st21ri2****
OrderId	string	No	The ID of the order.	20576750143****
AclSwitch	boolean	No	Specifies whether to query the access control list (ACL).	false
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data returned by the request.
Message	string	The returned message.	请求处理成功
RequestId	string	The request ID.	9515ACA4-E94D-440D-989E-C379FCED****
Data	object	The details of the cluster.
VpcId	string	The ID of the VPC.	vpc-bp1hcg467ekqsv0zr****
CreateTime	string	The creation time of the cluster.	2020-07-31 11:36:08
IntranetAddress	string	The private address.	192.168.XX.XX
DiskType	string	The disk type.	alicloud-disk-ssd-multi-zone
PubNetworkFlow	string	The public bandwidth in Mbit/s. The value is an integer from 0 to 5,000. A value of 0 indicates that the cluster is not accessible over the public network.	3
DiskCapacity	integer	The disk capacity in GB.	60
MemoryCapacity	integer	The memory capacity in GB.	2
ClusterAliasName	string	The alias of the cluster.	mse-7413****
InstanceCount	integer	The number of instances in the cluster.	3
IntranetPort	string	The private port.	8761
InstanceModels	array<object>	The list of instances in the cluster.
	object	An instance in the cluster.
PodName	string	The name of the pod.	mse-7413**-159616656**-reg-center-0-0
SingleTunnelVip	string	The virtual IP address (VIP) of a single tunnel.	192.168.XX.XX
InternetIp	string	The public IP address.	47.98.XX.XX
Ip	string	The IP address of the instance.	10.12.XX.XX
Role	string	The role of the instance.	Peer
HealthStatus	string	The health status of the instance.	Running
CreationTimestamp	string	The Unix timestamp, in milliseconds, that indicates when the instance was created.	1578575377732
Zone	string	The availability zone where the instance is located.	cn-shanghai-f
IntranetDomain	string	The private domain name.	mse-7413****-eureka.mse.aliyuncs.com
InternetDomain	string	The public domain name.	mse-7413****-p.eureka.mse.aliyuncs.com
PayInfo	string	Specifies the billing method, which is either `subscription` or `pay-as-you-go`.	按量付费
InternetAddress	string	The public address.	47.98.XX.XX
InstanceId	string	The ID of the instance.	mse-cn-st21ri2****
AclEntryList	string	The IP address whitelist.	[]
HealthStatus	string	The health status of the cluster.	RESTART_SUCCESS
InitCostTime	integer	The time it took to create the cluster, in milliseconds.	98408
RegionId	string	The ID of the region.	cn-hangzhou
AclId	string	The ID of the whitelist.	acl-bp17020kiqvzutwwj****
Cpu	integer	The number of CPU cores.	1
ClusterType	string	The type of the cluster. Valid values: `ZooKeeper`, `Nacos-Ans`, and `Eureka`.	Nacos-Ans
ClusterName	string	The name of the cluster.	mse-bc1a29b0-160230875****
InitStatus	string	The creation status of the cluster.	RESTART_SUCCESS
InternetPort	string	The public port.	8761
AppVersion	string	The application version.	1.2.1
NetType	string	The network type. Valid values: `privatenet`: The cluster is deployed in a VPC. `pubnet`: The cluster is accessible over the public network.	privatenet
ClusterVersion	string	The version of the cluster.	1.2.1
ClusterSpecification	string	The specifications of the cluster.	MSE_SC_1_2_200_c
VSwitchId	string	The ID of the vSwitch.	vsw-xxx-xxxx
ConnectionType	string	The network connection type. Valid values: `slb`: Server Load Balancer (SLB) `eni`: Elastic Network Interface (ENI)	slb
MseVersion	string	The edition of the Microservices Engine (MSE) instance.	mse_basic
ChargeType	string	Specifies the billing method, which is either `subscription` or `pay-as-you-go`.	按量付费
OrderClusterVersion	string	The originally purchased cluster version.	1.2.0
Tags	object	The tags attached to the instance.
ResourceGroupId	string	The ID of the resource group.	rg-aek2dhgysj*****
VersionLifecycle	string	The lifecycle status of the cluster version.
ErrorCode	string	The error code.	mse-100-000
Success	boolean	Indicates whether the request succeeded. Valid values: `true`: The request succeeded. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "Message": "请求处理成功",
  "RequestId": "9515ACA4-E94D-440D-989E-C379FCED****",
  "Data": {
    "VpcId": "vpc-bp1hcg467ekqsv0zr****",
    "CreateTime": "2020-07-31 11:36:08",
    "IntranetAddress": "192.168.XX.XX",
    "DiskType": "alicloud-disk-ssd-multi-zone",
    "PubNetworkFlow": "3",
    "DiskCapacity": 60,
    "MemoryCapacity": 2,
    "ClusterAliasName": "mse-7413****",
    "InstanceCount": 3,
    "IntranetPort": "8761",
    "InstanceModels": [
      {
        "PodName": "mse-7413****-159616656****-reg-center-0-0",
        "SingleTunnelVip": "192.168.XX.XX",
        "InternetIp": "47.98.XX.XX",
        "Ip": "10.12.XX.XX",
        "Role": "Peer",
        "HealthStatus": "Running",
        "CreationTimestamp": "1578575377732",
        "Zone": "cn-shanghai-f"
      }
    ],
    "IntranetDomain": "mse-7413****-eureka.mse.aliyuncs.com",
    "InternetDomain": "mse-7413****-p.eureka.mse.aliyuncs.com",
    "PayInfo": "按量付费",
    "InternetAddress": "47.98.XX.XX",
    "InstanceId": "mse-cn-st21ri2****",
    "AclEntryList": "[]",
    "HealthStatus": "RESTART_SUCCESS",
    "InitCostTime": 98408,
    "RegionId": "cn-hangzhou",
    "AclId": "acl-bp17020kiqvzutwwj****",
    "Cpu": 1,
    "ClusterType": "Nacos-Ans",
    "ClusterName": "mse-bc1a29b0-160230875****",
    "InitStatus": "RESTART_SUCCESS",
    "InternetPort": "8761",
    "AppVersion": "1.2.1",
    "NetType": "privatenet",
    "ClusterVersion": "1.2.1",
    "ClusterSpecification": "MSE_SC_1_2_200_c",
    "VSwitchId": "vsw-xxx-xxxx",
    "ConnectionType": "slb",
    "MseVersion": "mse_basic",
    "ChargeType": "按量付费",
    "OrderClusterVersion": "1.2.0",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ResourceGroupId": "rg-aek2dhgysj*****",
    "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.