All Products
Search
Document Center

Microservices Engine:QueryClusterInfo

Last Updated:Nov 20, 2024

Queries the static information of an instance.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringNo

The ID of the instance.

mse-09k1q11****
InstanceIdstringNo

The ID of the instance.

mse_prepaid_public_cn-7mz2t63ci03
OrderIdstringNo

The ID of the order.

20574710974****
AclSwitchbooleanNo

Specifies whether to query the configuration of a public IP address whitelist.

false
RegionIdstringNo

The ID of the region.

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

The response parameters.

Messagestring

The message 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.

415088B3-A7BE-56F6-9CD9-C42DE895CD41
Dataobject

The details of the data.

VpcIdstring

The ID of the VPC where the instance resides.

vpc-bp1v5nbauzh8xxxxxxx
CreateTimestring

The time when the instance was created.

2022-12-15 10:02:07
IntranetAddressstring

A reserved parameter.

null
DiskTypestring

A deprecated parameter.

null
PubNetworkFlowstring

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

1
DiskCapacitylong

A deprecated parameter.

null
MemoryCapacitylong

A deprecated parameter.

null
ClusterAliasNamestring

The alias of the instance.

Development environment
InstanceCountinteger

The number of instance nodes.

3
IntranetPortstring

The instance ports that are accessible over an internal network.

8848,6443,9848,8761
InstanceModelsarray<object>

The reserved structure.

InstanceModelobject

The reserved structure.

PodNamestring

A reserved parameter.

null
SingleTunnelVipstring

A reserved parameter.

null
InternetIpstring

A reserved parameter.

null
Ipstring

A reserved parameter.

null
Rolestring

A reserved parameter.

null
HealthStatusstring

A reserved parameter.

null
CreationTimestampstring

A reserved parameter.

null
Zonestring

A reserved parameter.

null
IntranetDomainstring

The internal endpoint.

mse-xxxxx-nacos-ans.mse.aliyuncs.com
InternetDomainstring

The public endpoint.

mse-xxxxxx-p.nacos-ans.mse.aliyuncs.com
PayInfostring

The billing method.

Pay-as-you-go
InternetAddressstring

A reserved parameter.

null
InstanceIdstring

The ID of the instance

mse-cn-st21ri2****
AclEntryListstring

The public IP address whitelist.

["127.0.0.0/32"]
HealthStatusstring

The status of the instance.

INIT_SUCCESS
InitCostTimelong

The time that is required to initialize the instance. Unit: milliseconds.

53353
RegionIdstring

The ID of the region.

cn-hangzhou
AclIdstring

The ID of the instance in the public IP address whitelist.

acl-bp144q24cgqvzckmxxxx
Cpuinteger

A deprecated parameter.

null
ClusterTypestring

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

Nacos-Ans
ClusterNamestring

The full name of the instance.

mse-74355150-xxxxxxx
InitStatusstring

The initial status of the instance.

INIT_SUCCESS
InternetPortstring

The instance ports that are accessible over the Internet.

8848,6443,9848,8761
AppVersionstring

The version of the instance.

2.1.0
NetTypestring

The network connection type of the instance.

privatenet
ClusterVersionstring

The version of the order.

NACOS_2_0_0
ClusterSpecificationstring

The engine specifications.

MSE_SC_2_4_60_c
VSwitchIdstring

The ID of the vSwitch.

vsw-bp1egfakxxxxx
ConnectionTypestring

A deprecated parameter.

null
MseVersionstring

The version of the instance.

mse_pro
ChargeTypestring

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

POSTPAY
Tagsobject

The tag.

ExpectZonesarray

The zones to which the current cluster can be distributed.

ExpectZonestring

The zone ID.

cn-hangzhou-k
MaintenancePeriodobject

The O&M time window.

EndTimestring

The start time of the O&M time window.

02:00
StartTimestring

The end time of the O&M time window.

06:00
EndDatestring

The time when the subscription instance expires.

2021-08-01 00:00:00
SecurityGroupIdstring

The ID of the security group to which the elastic network interface (ENI) is connected.

sg-uf6hgwe067prhg68agfa
SecurityGroupTypestring

The type of the security group to which the ENI is connected.

enterprise
EipInstanceIdstring

The ID of the instance that is associated with the Elastic IP Address (EIP).

eip-bp1uujshd5funmyy8rcl9
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": "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"
  },
  "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-12-20The response structure of the API has changedView Change Details
2023-10-11The response structure of the API has changedView Change Details
2023-08-29The response structure of the API has changedView Change Details
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