All Products
Search
Document Center

Microservices Engine:ListEurekaServices

Last Updated:Feb 13, 2023

Queries Eureka services.

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 resources is 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.
Operateaccess levelResource typeconditional keywordAssociation operation
mse:ListEurekaServicesRead
  • MSE
    acs:mse:{#regionId}:{#accountId}:instance/*
    without
without

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 instance.

mse-09k1q11****
RegionIdstringYes

The region ID.

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 returned instances.

7
RequestIdstring

The ID of the request.

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

The message returned.

The request is successfully processed.
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 details of the instance.

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 failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

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": [
    {
      "InstancesId": [
        "mse-cn-st21ri2****"
      ],
      "Name": "CONTACTINFO",
      "UpStatus": "1/1"
    }
  ],
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

Http codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
400invalidParameterparameter error:%sInvalid input parameter: %s
403NoPermissionYou are not authorized to perform this operation.-
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.
500regcenterErrorregister center error:%sInstance request error: %s

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

Change history

Change timeSummary of changesOperate
No change history