All Products
Search
Document Center

Microservices Engine:QueryInstancesInfo

Last Updated:Aug 12, 2024

Queries the runtime data of a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:QueryInstancesInfoget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The ID of the cluster.

mse-09k1q11****
InstanceIdstringNo

The ID of the instance.

mse_prepaid_public_cn-tl32g1u9k01
OrderIdstringNo

The ID of the order.

20574710974****
RegionIdstringNo

The ID of the region where the instance resides.

cn-hangzhou
RequestParsstringNo

The extended request parameters in the JSON format.

{}
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

BaseResult

Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Messagestring

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.
RequestIdstring

The ID of the request.

54973C90-F379-4372-9AA5-053A3F7****
ErrorCodestring

The error code returned if the request failed.

mse-100-000
HttpCodestring

The HTTP status code.

202
Dataarray<object>

The details of the data.

object

The details of the data.

HealthStatusstring

A reserved parameter.

null
Rolestring

A reserved parameter.

null
PodNamestring

The pod name.

mse-xxxxx-xxxxx-reg-center-0-1
Ipstring

The IP address of the pod.

25.24.91.x
InternetIpstring

The public IP address.

120.55.71.x
SingleTunnelVipstring

The internal IP address.

172.16.66.x
CreationTimestampstring

The creation time.

2022-12-15T02:02:15Z
ClientPortstring

The enabled port.

8848
Zonestring

The zone ID.

cn-hangzhou-k
ZoneDistributedboolean

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 codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

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

Change history

Change timeSummary of changesOperation
2023-07-03The response structure of the API has changedView Change Details
2023-04-25The internal configuration of the API is changed, but the call is not affectedView Change Details