All Products
Search
Document Center

ListEurekaServices

Last Updated: Jul 01, 2022

Queries Eureka services.

Authorization information

There is currently no authorization information disclosed in the API.

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
ClusterIdstringYes

The ID of the cluster.

mse-09k1q11****
RegionIdstringYes

The ID of the region.

cn-hangzhou
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

HttpCodestring

The HTTP status code returned.

202
TotalCountinteger

The total number of entries returned.

7
RequestIdstring

The ID of the request.

316F5F64-F73D-42DC-8632-01E308B6****
Messagestring

The message returned.

The request is processed successfully.
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
Dataarray

The details of the data.

object

The data structure.

InstancesIdarray

The information about instances.

string

The ID of the instance.

mse-cn-st21ri2****
Namestring

The name of the service.

CONTACTINFO
UpStatusstring

The number of service providers. The value is in the following format: Number of healthy instances/Total number of instances.

1/1
ErrorCodestring

The error code returned if the request fails.

mse-100-000
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request is successful.
  • false: The request fails.
true

Example

Request example

http(s)://[Endpoint]/?Action=ListEurekaServices
&ClusterId=mse-09k1q11****
&PageNum=1
&PageSize=10
&RegionId=cn-hangzhou
&<Common request parameters>

Normal return example

JSONFormat

{
    "HttpCode": 202,
    "TotalCount": 7,
    "PageSize": 10,
    "Message": "The request is processed successfully.",
    "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
    "PageNumber": 1,
    "Data": {
        "UpStatus": "1/1",
        "Name": "CONTACTINFO",
        "InstancesId": "mse-cn-st21ri2****"
    },
    "ErrorCode": "mse-100-000",
    "Success": true
}

XMLFormat

<ListEurekaServicesResponse>
<HttpCode>202</HttpCode>
<TotalCount>7</TotalCount>
<PageSize>10</PageSize>
<Message>The request is processed successfully.</Message>
<RequestId>316F5F64-F73D-42DC-8632-01E308B6****</RequestId>
<PageNumber>1</PageNumber>
<Data>
    <UpStatus>1/1</UpStatus>
    <Name>CONTACTINFO</Name>
    <InstancesId>mse-cn-st21ri2****</InstancesId>
</Data>
<ErrorCode>mse-100-000</ErrorCode>
<Success>true</Success>
</ListEurekaServicesResponse>

Error codes

For a list of error codes, visit the API error center.