GetServiceListPage - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves a list of services.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:GetServiceListPage

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region.	cn-hangzhou
Namespace	string	No	The name of the MSE namespace.	default
AppName	string	No	The name of the application.	example-app
ServiceType	string	No	The type of the service.	springCloud
AppId	string	No	The ID of the application.	dez4xxxxx@f3f75ed8ffxxxxx
ServiceName	string	No	The name of the service.	sc-A
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	10
Ip	string	No	The IP address to query.	223.5.5.5
AcceptLanguage	string	No	The language of the response. Valid values: `zh` (default): Chinese, and `en`: English.	zh

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	True
Message	string	The message that is returned.	OK
RequestId	string	The request ID.	A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx
Data	object	The returned data.
Result	array<object>	The data on the current page.
	object	The information about each service.
AppName	string	The name of the application.	example-app
Version	string	The version of the service.	1
InstanceNum	integer	The number of nodes for the service.	1
GmtModifyTime	string	The time when the service was last updated.	123456
AppId	string	The ID of the application.	dez4xxxxx@f3f75ed8ffxxxxx
ServiceName	string	The name of the service.	sc-A
Group	string	The service group.	DEFAULT_GROUP
ServiceType	string
TotalSize	string	The total number of entries.	100
PageNumber	string	The current page number.	1
PageSize	string	The number of entries per page.	10

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "OK",
  "RequestId": "A2F946FB-F2E3-5BF4-8CBE-xxxxxxxx",
  "Data": {
    "Result": [
      {
        "AppName": "example-app",
        "Version": "1",
        "InstanceNum": 1,
        "GmtModifyTime": "123456",
        "AppId": "dez4xxxxx@f3f75ed8ffxxxxx",
        "ServiceName": "sc-A",
        "Group": "DEFAULT_GROUP",
        "ServiceType": ""
      }
    ],
    "TotalSize": "100",
    "PageNumber": "1",
    "PageSize": "10"
  }
}

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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.