QueryInstancesInfo - Microservices Engine - Alibaba Cloud Documentation Center

Queries the runtime data of a specified cluster.

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:QueryInstancesInfo	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The ID of the cluster.	mse-09k1q11****
InstanceId	string	No	The ID of the instance.	mse_prepaid_public_cn-tl32g1u9k01
OrderId	string	No	The ID of the order.	20574710974****
RegionId	string	No	The ID of the region where the instance resides.	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	BaseResult
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Message	string	The message that is returned. If the request is successful, a success message is returned. If the request fails, an error message is returned.	The request is successfully processed.
RequestId	string	The ID of the request.	54973C90-F379-4372-9AA5-053A3F7****
ErrorCode	string	The error code returned if the request failed.	mse-100-000
HttpCode	string	The HTTP status code.	202
Data	array<object>	The details of the data.
InstanceModels	object	The details of the data.
HealthStatus	string	A reserved parameter.	null
Role	string	A reserved parameter.	null
PodName	string	The pod name.	mse-xxxxx-xxxxx-reg-center-0-1
Ip	string	The IP address of the pod.	25.24.91.x
InternetIp	string	The public IP address.	120.55.71.x
SingleTunnelVip	string	The internal IP address.	172.16.66.x
CreationTimestamp	string	The creation time.	2022-12-15T02:02:15Z
ClientPort	string	The enabled port.	8848
Zone	string	The zone ID.	cn-hangzhou-k
ZoneDistributed	boolean	Indicates whether all pods in the cluster are distributed in the specified zones.	true

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Message": "The request is successfully processed.\n",
  "RequestId": "54973C90-F379-4372-9AA5-053A3F7****",
  "ErrorCode": "mse-100-000",
  "HttpCode": "202",
  "Data": [
    {
      "HealthStatus": "null",
      "Role": "null",
      "PodName": "mse-xxxxx-xxxxx-reg-center-0-1",
      "Ip": "25.24.91.x",
      "InternetIp": "120.55.71.x",
      "SingleTunnelVip": "172.16.66.x",
      "CreationTimestamp": "2022-12-15T02:02:15Z",
      "ClientPort": "8848",
      "Zone": "cn-hangzhou-k",
      "ZoneDistributed": 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
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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s

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

Change history

Change time	Summary of changes	Operation
2023-07-03	The response structure of the API has changed	View Change Details
2023-04-25	The internal configuration of the API is changed, but the call is not affected	View Change Details