All Products
Search
Document Center

Microservices Engine:GetApplicationList

Last Updated:Nov 20, 2024

Obtains the list of applications.

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:GetApplicationListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionstringYes

The ID of the region.

cn-hangzhou
AppNamestringNo

The name of an application.

rest-container
AppIdstringNo

The ID of an application.

hkhon1po62@c3df23522b*****
SourcestringNo

The source of the application. The value is fixed as edasmsc.

edasmsc
LanguagestringNo

The programming language of the application, such as Java and Go.

Java
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerYes

The number of entries to return on each page.

10
SwitchEnablebooleanNo

Specifies whether to enable switching.

true
SentinelEnablebooleanNo

Specifies whether to enable the Sentinel-compatible mode.

true
NamespacestringNo

The microservice namespace to which the application belongs.

default
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Successboolean

Indicates whether the request was successful. Valid values:

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

The message returned.

The request is successfully processed.
RequestIdstring

The ID of the request.

F55E608F-7C15-****-9CFD-DF832EBC4A0F
Dataobject

The details of the data.

Resultarray<object>

The data returned.

ApplicationListobject

The data structure.

Statuslong

The status.

0
ExtraInfostring

The additional information.

{}
AppNamestring

The name of the application.

finance
AppIdstring

The ID of the application.

hkhon1po62@5f1b08becb*****
UserIdstring

The user ID.

1234567890
InstancesNumberinteger

The number of instances.

1
Sourcestring

The source of the application.

edasmsc
Languagestring

The programming language of the application.

JAVA
RegionIdstring

The region ID.

cn-hangzhou
Namespacestring

The microservice namespace to which the application belongs.

default
TotalSizeinteger

The total number of entries returned.

11
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10

Examples

Sample success responses

JSONformat

{
  "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"
      }
    ],
    "TotalSize": 11,
    "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-06The response structure of the API has changedView Change Details
2023-07-13The response structure of the API has changedView Change Details
2023-06-26API Description Update. The response structure of the API has changedView Change Details
2021-05-10Add OperationView Change Details