GetApplicationList - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves the list of applications.

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:GetApplicationList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region.	cn-hangzhou
AppName	string	No	The application name.	rest-container
AppId	string	No	The application ID.	hkhon1po62@c3df23522b*****
Source	string	No	The source of the application. The value is fixed as edasmsc.	edasmsc
Language	string	No	The programming language, such as Java or Go.	Java
PageNumber	integer	Yes	The page number.	1
PageSize	integer	Yes	The number of entries per page.	10
SwitchEnable	boolean	No	Specifies whether to enable the switch.	true
SentinelEnable	boolean	No	Specifies whether to enable the Sentinel component.	true
Namespace	string	No	The microservice namespace to which the application belongs.	default
Tags	array	No	Alibaba Cloud tags. You can perform filtering by Alibaba Cloud tag.
	object	No	The tag.
Key	string	No	The custom tag key. It can contain up to 128 characters and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.
Value	string	No	The tag value.
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Parameter	Type	Description	Example
	object	The data structure.
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Message	string	The message.	The request is successfully processed.
RequestId	string	The request ID.	F55E608F-7C15-****-9CFD-DF832EBC4A0F
Data	object	The data structure.
Result	array	The information about the applications.
	object	The data structure.
Status	integer	The status.	0
ExtraInfo	string	The additional information.	{}
AppName	string	The application name.	finance
AppId	string	The application ID.	hkhon1po62@5f1b08becb*****
UserId	string	The user ID.	1234567890
InstancesNumber	integer	The total number of instances.	1
Source	string	The source of the application.	edasmsc
Language	string	The programming language of the application.	JAVA
RegionId	string	The region ID.	cn-hangzhou
Namespace	string	The microservice namespace to which the application belongs.	default
Tags	object	The Alibaba Cloud tags.
TotalSize	integer	The total number of entries.	11
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "The request is successfully processed.\n",
  "RequestId": "F55E608F-7C15-****-9CFD-DF832EBC4A0F",
  "Data": {
    "Result": [
      {
        "Status": 0,
        "ExtraInfo": "{}",
        "AppName": "finance",
        "AppId": "hkhon1po62@5f1b08becb*****",
        "UserId": "1234567890",
        "InstancesNumber": 1,
        "Source": "edasmsc",
        "Language": "JAVA",
        "RegionId": "cn-hangzhou",
        "Namespace": "default",
        "Tags": {
          "test": "test",
          "test2": 1
        }
      }
    ],
    "TotalSize": 11,
    "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.