All Products
Search
Document Center

Microservices Engine:ListAnsInstances

Last Updated:Nov 13, 2024

Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance.

Operation description

Note The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The extended request parameters in the JSON format.

{}
PageNumintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10
ClusterIdstringNo

The ID of the Nacos instance.

Note This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.
mse-09k1q11****
ServiceNamestringYes

The name of the service.

name
GroupNamestringNo

The name of the contact group.

test
NamespaceIdstringNo

The ID of the namespace.

12233****
ClusterNamestringNo

The alias of the Nacos instance.

mse-7413****
InstanceIdstringNo

The ID of the instance.

Note This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.
mse_prepaid_public_cn-tl327w****
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
HttpCodestring

The HTTP status code returned.

202
TotalCountinteger

The total number of returned instances.

7
RequestIdstring

The ID of the request.

52BA6DA6-A702-4362-A32F-DFF79655****
Messagestring

The message returned.

The request was successfully processed.
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The number of the page to return.

1
Dataarray<object>

The details of the data.

NacosAnsInstanceobject
DefaultKeystring

The default key.

30.5.XX.XX:unknown
Ephemeralboolean

Indicates whether the information about the ephemeral node is obtained. Valid values:

  • true: yes
  • false: no
true
Markedboolean

Indicates whether the instance was marked. Valid values:

  • true: The instance marking was successful.
  • false: The instance marking failed.
true
Ipstring

The public IP address.

30.5.XX.XX
InstanceIdstring

The ID of the instance.

30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService
Portinteger

The port number.

8080
LastBeatlong

The last heartbeat time.

20201010
OkCountinteger

The number of counted successes.

0
Weightinteger

The weight.

1
InstanceHeartBeatIntervalinteger

The heartbeat interval of the instance. Unit: seconds.

5000
IpDeleteTimeoutinteger

The timeout period for removing an IP address.

30000
Appstring

The name of the application.

app
FailCountinteger

The number of counted failures.

0
Healthyboolean

The health status of the instance. Valid values:

  • true: The instance is healthy.
  • false: The instance is unhealthy.
true
Enabledboolean

The effective status of the instance. Valid values:

  • true: The instance takes effect.
  • false: The instance does not take effect.
true
DatumKeystring

The reference key.

30.5.XX.XX:unknown:DEFAULT
ClusterNamestring

The name of the cluster.

DEFAULT
InstanceHeartBeatTimeOutinteger

The timeout period of the instance heartbeat.

15000
ServiceNamestring

The name of the service.

DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::
Metadataobject

The metadata.

[int]
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

{
  "HttpCode": "202",
  "TotalCount": 7,
  "RequestId": "52BA6DA6-A702-4362-A32F-DFF79655****",
  "Message": "The request was successfully processed.\n",
  "PageSize": 10,
  "PageNumber": 1,
  "Data": [
    {
      "DefaultKey": "30.5.XX.XX:unknown",
      "Ephemeral": true,
      "Marked": true,
      "Ip": "30.5.XX.XX",
      "InstanceId": "30.5.XX.XX#0#DEFAULT#DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService",
      "Port": 8080,
      "LastBeat": 20201010,
      "OkCount": 0,
      "Weight": 1,
      "InstanceHeartBeatInterval": 5000,
      "IpDeleteTimeout": 30000,
      "App": "app",
      "FailCount": 0,
      "Healthy": true,
      "Enabled": true,
      "DatumKey": "30.5.XX.XX:unknown:DEFAULT",
      "ClusterName": "DEFAULT",
      "InstanceHeartBeatTimeOut": 15000,
      "ServiceName": "DEFAULT_GROUP@@consumers:com.alibaba.edas.IHelloService::",
      "Metadata": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "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
2024-06-27API Description UpdateView Change Details