GetApplicationInstanceList API Reference - MSE - Alibaba Cloud - Microservices Engine

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Namespace	string	No	The Microservices Engine (MSE) namespace to which the application belongs.	default
AppName	string	No	The application name.	example-app
AppId `deprecated`	string	No	The application ID.	abcde@12345
Tag	string	No	The tags that you want to add to nodes.	gray
PageNumber	integer	Yes	The page number. Pages start from page 1.	1
PageSize	integer	Yes	The number of entries per page.	20
Region	string	No	The region.	cn-hangzhou
AcceptLanguage	string	No	The response language. Valid values: zh (Chinese, default) and en (English).	zh

Response elements

Element	Type	Description	Example
	object
Data	object	The returned data.
Result	array<object>	The queried nodes.
	array<object>
Ip	string	The node IP address.	10.1.2.3
Tags	array<object>	The node tags.
	object
Tag	string	The tag value.	gray
Port	string	The application port.	8080
TotalSize	integer	The total number of nodes.	100
PageNumber	integer	The page number. Pages start from page 1.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "Data": {
    "Result": [
      {
        "Ip": "10.1.2.3",
        "Tags": [
          {
            "Tag": "gray"
          }
        ],
        "Port": "8080"
      }
    ],
    "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.