All Products
Search
Document Center

Microservices Engine:QueryClusterDetail

Last Updated:Apr 17, 2024

Queries the details of an instance.

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:QueryClusterDetailRead
  • Cluster
    acs:mse:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

mse-cn-st21ri2****
OrderIdstringNo

The ID of the order.

20576750143****
AclSwitchbooleanNo

Specifies whether to query access control lists (ACLs).

false
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The string object.

Messagestring

The message returned.

The request is successfully processed.
RequestIdstring

The ID of the request.

9515ACA4-E94D-440D-989E-C379FCED****
Dataobject

The details of the data.

VpcIdstring

The ID of the virtual private cloud (VPC).

vpc-bp1hcg467ekqsv0zr****
CreateTimestring

The time when the instance was created.

2020-07-31 11:36:08
IntranetAddressstring

The internal IP address.

192.168.XX.XX
DiskTypestring

The type of the disk.

alicloud-disk-ssd-multi-zone
PubNetworkFlowstring

The public bandwidth. Unit: Mbit/s.
Valid values: 0 to 5000. The value 0 indicates no access to the Internet.

3
DiskCapacitylong

The capacity of the disk. Unit: GB.

60
MemoryCapacitylong

The size of the memory. Unit: GB.

2
ClusterAliasNamestring

The alias of the instance.

mse-7413****
InstanceCountinteger

The number of instance nodes.

3
IntranetPortstring

The private port number.

8761
InstanceModelsobject []

The list of instance nodes.

PodNamestring

The name of the pod.

mse-7413****-159616656****-reg-center-0-0
SingleTunnelVipstring

The single-thread IP address.

192.168.XX.XX
InternetIpstring

The public IP address.

47.98.XX.XX
Ipstring

The IP address of the instance.

10.12.XX.XX
Rolestring

The role.

Peer
HealthStatusstring

The health status of the instance.

Running
CreationTimestampstring

The timestamp when the instance was created.

1578575377732
Zonestring

The zone ID.

cn-shanghai-f
IntranetDomainstring

The internal endpoint of the instance.

mse-7413****-eureka.mse.aliyuncs.com
InternetDomainstring

The public endpoint of the instance.

mse-7413****-p.eureka.mse.aliyuncs.com
PayInfostring

The billing method, such as subscription or pay-as-you-go.

Pay-as-you-go
InternetAddressstring

The public IP address of the instance.

47.98.XX.XX
InstanceIdstring

The ID of the instance.

mse-cn-st21ri2****
AclEntryListstring

The whitelist.

[]
HealthStatusstring

The health status of the instance.

RESTART_SUCCESS
InitCostTimelong

The amount of time taken to create the instance. Unit: milliseconds.

98408
RegionIdstring

The region ID.

cn-hangzhou
AclIdstring

The ID of the whitelist.

acl-bp17020kiqvzutwwj****
Cpuinteger

The number of vCPUs.

1
ClusterTypestring

The type of the instance. Valid values: ZooKeeper, Nacos-Ans, and Eureka.

Nacos-Ans
ClusterNamestring

The name of the instance.

mse-bc1a29b0-160230875****
InitStatusstring

The creation status of the instance.

RESTART_SUCCESS
InternetPortstring

The private port number.

8761
AppVersionstring

The application version.

1.2.1
NetTypestring

The network type of the instance. Valid values:

  • privatenet: VPC
  • pubnet: Internet
privatenet
ClusterVersionstring

The version of the instance.

1.2.1
ClusterSpecificationstring

The engine specifications.

MSE_SC_1_2_200_c
VSwitchIdstring

The ID of the vSwitch.

vsw-xxx-xxxx
ConnectionTypestring

The network connection type. Valid values:

  • slb
  • eni
slb
MseVersionstring

The edition of Microservices Engine (MSE).

mse_basic
ChargeTypestring

The billing method, such as subscription or pay-as-you-go.

Pay-as-you-go
OrderClusterVersionstring

The version number of the original order.

1.2.0
Tagsobject

The tags that are attached to the instance.

ResourceGroupIdstring

The ID of the resource group.

rg-aek2dhgysj*****
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

{
  "Message": "The request is successfully processed.\n",
  "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": "Pay-as-you-go\n",
    "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": "Pay-as-you-go\n",
    "OrderClusterVersion": "1.2.0",
    "Tags": {
      "test": "test",
      "test2": 1
    },
    "ResourceGroupId": "rg-aek2dhgysj*****"
  },
  "ErrorCode": "mse-100-000",
  "Success": 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-05-17The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.