Queries Nacos services.
Operation description
Note
The operation is not provided in Nacos SDKs. For information about Nacos SDKs, see the official documentation.
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 Resourcesis 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:ListAnsServices | list | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ServiceName | string | No | The name of the service. | name |
| GroupName | string | No | The name of the contact group. | name |
| NamespaceId | string | No | The ID of the namespace. | 12233**** |
| HasIpCount | string | No | Specifies whether to query the number of instances that are used for the service. | true |
| ClusterId | string | Yes | The ID of the cluster. Note
This operation contains both the InstanceId and ClusterId parameters. You must specify one of them.
| mse-09k1q11**** |
| 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-cn-st21v5**** |
| PageNum | integer | Yes | The number of the page to return. | 1 |
| PageSize | integer | Yes | The number of entries returned per page. | 10 |
| RequestPars | string | No | The extended request parameters in the JSON format. | {} |
| AcceptLanguage | string | No | The language of the response. Valid values:
| zh |
Response parameters
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": [
{
"HealthyInstanceCount": 1,
"GroupName": "name",
"IpCount": 1,
"Name": "name",
"ClusterCount": 1,
"Source": ""
}
],
"ErrorCode": "mse-100-000",
"Success": true
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | duplicatedClusterAliasName | duplicated cluster alias name | The instance name is duplicate. User another name. |
| 400 | illegalRequest | illegal request:%s | Invalid request: %s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | You do not have the permission to use this interface:%s |
| 404 | clusterNotFound | cluster not found | The cluster is not found. |
| 500 | systemError | system error | An error occurred on the system. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-27 | The internal configuration of the API is changed, but the call is not affected | View Change Details |