Queries application instances that are registered with a Microservices Engine (MSE) Nacos instance.
Operation description
Debugging
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:ListAnsInstances | list |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RequestPars | string | No | The extended request parameters in the JSON format. | {} |
PageNum | integer | Yes | The number of the page to return. | 1 |
PageSize | integer | Yes | The number of entries to return on each page. | 10 |
ClusterId | string | No | The ID of the Nacos instance. Note
This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.
| mse-09k1q11**** |
ServiceName | string | Yes | The name of the service. | name |
GroupName | string | No | The name of the contact group. | test |
NamespaceId | string | No | The ID of the namespace. | 12233**** |
ClusterName | string | No | The alias of the Nacos instance. | mse-7413**** |
InstanceId | string | No | 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**** |
AcceptLanguage | string | No | The language of the response. Valid values:
| zh |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 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 |
---|---|---|
2024-06-27 | API Description Update | View Change Details |