All Products
Search
Document Center

Microservices Engine:GetApplicationInstanceList

Last Updated:Nov 13, 2024

Queries a list of microservice application instances.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • 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 Key: the condition key that is defined by the cloud service.
  • 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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:GetApplicationInstanceListget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamespacestringNo

The Microservices Engine (MSE) namespace to which the application belongs.

default
AppNamestringNo

The application name.

example-app
AppIddeprecatedstringYes

The application ID.

abcde@12345
TagstringYes

The tags that you want to add to nodes.

gray
PageNumberstringYes

The page number. Pages start from page 1.

1
PageSizestringYes

The number of entries per page.

20
RegionstringNo

The region.

cn-hangzhou
AcceptLanguagestringNo

The language in which you want to display the results. Valid values: zh and en. zh indicates Chinese, which is the default value. en indicates English.

zh

Response parameters

ParameterTypeDescriptionExample
object
Dataobject

The returned data.

Resultarray<object>

The queried nodes.

RoutePolicyListobject
Ipstring

The node IP address.

10.1.2.3
Tagsarray<object>

The node tags.

Portstring

The application port.

8080
TotalSizeinteger

The total number of nodes.

100
PageNumberinteger

The page number. Pages start from page 1.

1
PageSizeinteger

The number of entries per page.

10

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Result": [
      {
        "Ip": "10.1.2.3",
        "Tags": [
          {
            "Tag": "gray"
          }
        ],
        "Port": "8080"
      }
    ],
    "TotalSize": 100,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-09-15The internal configuration of the API is changed, but the call is not affectedView Change Details
2023-09-13The response structure of the API has changedView Change Details