Queries Eureka instances.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
| Operate | access level | Resource type | conditional keyword | Association operation |
|---|---|---|---|---|
| mse:ListEurekaInstances | Read |
|
| without |
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 instance. | mse-09k1q11**** |
| ServiceName | string | Yes | The name of the service. | name |
| AcceptLanguage | string | No | The language of the response. Valid values:
| zh |
Response parameters
Example
Normal return example
JSONFormat
{
"HttpCode": "202",
"TotalCount": 7,
"RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
"Message": "The request is successfully processed.\n",
"PageSize": 10,
"PageNumber": 1,
"Data": [
{
"Status": "1/1",
"LastDirtyTimestamp": 20201009115543,
"IpAddr": "30.5.XX.XX",
"HomePageUrl": "http://30.5.XX.XX:8091/",
"HostName": "30.5.XX.XX",
"InstanceId": "L-PC1A6A28-****.hz.ali.com:contactinfo:8091",
"Port": 8091,
"SecurePort": 443,
"App": "CONTACTINFO",
"DurationInSecs": 90,
"LastUpdatedTimestamp": 20201010071203,
"RenewalIntervalInSecs": 10,
"VipAddress": "contactinfo",
"Metadata": {
"test": "test",
"test2": 1
}
}
],
"ErrorCode": "mse-100-000",
"Success": true
}Error codes
| Http 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 |
| 400 | invalidParameter | parameter error:%s | Invalid input parameter: %s |
| 403 | NoPermission | You are not authorized to perform this operation. | - |
| 404 | clusterNotFound | cluster not found | The cluster is not found. |
| 500 | systemError | system error | An error occurred on the system. Try again later. |
| 500 | regcenterError | register center error:%s | Instance request error: %s |
For a list of error codes, visit the API error center.