All Products
Search
Document Center

:ListApplications

Last Updated:Aug 01, 2024

The ID of the namespace.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
sae:ListApplicationsget
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/app/listApplications

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The number of the returned page.

1
PageSizeintegerNo

Indicates whether the application is being deleted. Valid values:

  • true: The application is being deleted.
  • false: The application is not being deleted.
20
AppNamestringNo

The HTTP status code. Valid values:

  • 2xx: indicates that the request was successful.
  • 3xx: indicates that the request was redirected.
  • 4xx: indicates that the request was invalid.
  • 5xx: indicates that a server error occurred.
demo-app
NamespaceIdstringNo

1

cn-beijing:demo
TagsstringNo

The list of applications.

[{"key":"key","value":"value"}]
OrderBystringNo

runnings

running
ReversebooleanNo

The returned message.

true
FieldTypestringNo

true

appName
FieldValuestringNo

The ID of the region.

demo-app
AppSourcestringNo

The SAE application type. Valid values:

  • micro_service
  • web
  • job
micro_service

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Messagestring

20

success
RequestIdstring

The number of entries returned on each page.

B4D805CA-926D-41B1-8E63-7AD0C1ED****
Dataobject

The queried applications.

CurrentPageinteger

The number of application instances.

1
TotalSizeinteger

The information about applications.

2
PageSizeinteger

The tags of the application.

20
Applicationsarray<object>

The applications.

object
AppNamestring

The application name.

demo-app
NamespaceIdstring

The namespace ID.

cn-beijing:demo
AppDeletingStatusboolean

Indicates whether the application is being deleted. Valid values:

  • true: The application is being deleted.
  • false: The application is not being deleted.
false
AppIdstring

The application ID.

f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tagsarray<object>

The tags of the application.

object
Keystring

The key of the tag.

key
Valuestring

The value of the tag.

value
RunningInstancesinteger

The number of running instances.

2
Instancesinteger

The number of application instances.

2
RegionIdstring

The region ID.

cn-beijing
AppDescriptionstring

The description of the application.

description
Cpuinteger

The CPU specifications that are required for each instance. Unit: millicores. This parameter cannot be set to 0. Valid values:

  • 500
  • 1000
  • 2000
  • 4000
  • 8000
  • 16000
  • 32000
1000
Meminteger

The memory size that is required by each instance. Unit: MB. This parameter cannot be set to 0. The values of this parameter correspond to the values of the Cpu parameter:

  • This parameter is set to 1024 if the Cpu parameter is set to 500 or 1000.
  • This parameter is set to 2048 if the Cpu parameter is set to 500, 1000, or 2000.
  • This parameter is set to 4096 if the Cpu parameter is set to 1000, 2000, or 4000.
  • This parameter is set to 8192 if the Cpu parameter is set to 2000, 4000, or 8000.
  • This parameter is set to 12288 if the Cpu parameter is set to 12000.
  • This parameter is set to 16384 if the Cpu parameter is set to 4000, 8000, or 16000.
  • This parameter is set to 24576 if the Cpu parameter is set to 12000.
  • This parameter is set to 32768 if the Cpu parameter is set to 16000.
  • This parameter is set to 65536 if the Cpu parameter is set to 8000, 16000, or 32000.
  • This parameter is set to 131072 if the Cpu parameter is set to 32000.
1024
ErrorCodestring

The number of entries returned on each page.

The ID of the request.
Codestring

Queries applications.

200
Successboolean

1

true
CurrentPageinteger

20

1
TotalSizeinteger

demo-app

2
PageSizeinteger

cn-beijing:demo

20

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data": {
    "CurrentPage": 1,
    "TotalSize": 2,
    "PageSize": 20,
    "Applications": [
      {
        "AppName": "demo-app",
        "NamespaceId": "cn-beijing:demo",
        "AppDeletingStatus": false,
        "AppId": "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
        "Tags": [
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "RunningInstances": 2,
        "Instances": 2,
        "RegionId": "cn-beijing",
        "AppDescription": "description",
        "Cpu": 1000,
        "Mem": 1024,
        "MseEnabled": true,
        "MseNamespaceId": "",
        "BaseAppId": "",
        "ProgrammingLanguage": "",
        "Children": [
          {
            "AppName": "",
            "NamespaceId": "",
            "AppDeletingStatus": true,
            "AppId": "",
            "ScaleRuleEnabled": true,
            "ScaleRuleType": "",
            "Tags": [
              {
                "Key": "",
                "Value": ""
              }
            ],
            "RunningInstances": 0,
            "Instances": 0,
            "RegionId": "",
            "AppDescription": "",
            "Cpu": 0,
            "Mem": 0,
            "MseEnabled": true,
            "BaseAppId": "",
            "ProgrammingLanguage": ""
          }
        ]
      }
    ]
  },
  "ErrorCode": "The ID of the request.\n",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

Error codes

HTTP status codeError codeError message
400Illegal.argumentIllegal argument

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

Change history

Change timeSummary of changesOperation
2024-05-24The Error code has changed. The response structure of the API has changedView Change Details
2024-05-21The Error code has changed. The response structure of the API has changedView Change Details
2024-01-22The Error code has changed. The request parameters of the API has changedView Change Details
2021-07-21The Error code has changedView Change Details