All Products
Search
Document Center

ENS:ListApplications

Last Updated:Mar 12, 2024

Queries the created applications.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterNamesstringNo

The name of the application cluster. Separate multiple names with commas (,). If you want to query applications of all clusters in your account, specify All for this parameter. Default value: All.

poc,pre
AppVersionsstringNo

The version number of the application. Separate multiple version numbers with commas (,). If you want to query data of all versions of applications, specify All for this parameter. By default, only data of applications in the stable versions are queried.

v1,v2
LevelstringNo

The region level by which edge resources of the application are collected. The value is of the enumeration type. Valid values:

  • National: Chinese mainland
  • Big: area
  • Middle: province
  • Small: city
  • RegionId: edge node

Default value: National.

National
OutAppInfoParamsstringNo

Specifies whether to return other information about the application, such as statistics on resource instances and pods. The value must be a JSON string. By default, all information is returned.

{\"appInfo\":true,\"detailStat\": true, \"appVersionStat\": true, \"districtStat\":true ,\"instanceStat\": true, \"podCountStat\": true}
PageNumberintegerNo

The page number. Pages start from page 1. This parameter is optional if you want to return all information about the applications.

1
PageSizeintegerNo

The number of entries per page. This parameter is optional if you want to return all information about the applications.

10
MinDatestringNo

The beginning of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.

2022-02-15
MaxDatestringNo

The end of the time range to query. Specify the time in the 2006-01-02 format. By default, the time range to query is not restricted.

2022-02-20

Response parameters

ParameterTypeDescriptionExample
object
Applicationsobject []

Details about applications.

AppListobject []

Details about the application.

AppIdstring

The ID of the application.

e76f8985-7965-41fc-925b-9648bb6bf650
AppInfostring

The information about the application, such as the resource specification, parameter configuration, and resources.

{ "AppStatus":{ "Phase":"RUNNING", "StatusDescrip":"{\"status\":\"UPDATE_SUCCESS\",\"step\":\"DONE\",\"descrip\":\"update to version:1022 success\",\"start_time\":\"2022-03-01 16:18:22\"}", "UpdateTime":"2022-03-01 16:18:22", "OrderStatus":null }, "ResourceAttribute":{ "NetSecurityInfo":null, "InitConfig":null, "InventoryType":"Ens", "InstanceSpec":"ens.gi6s-c12g1.large", "SystemDiskSize":100, "DataDiskSize":0, "BandwithOut":5000, "SchedulingStrategy":"Disperse", "ImageId":"m-5or73kzkuxytv7hh6wxr6yc5q", "ResourceType":"Linux", "AreaLevel":"National", "IpType":"PublicIP" }, "WorkloadAttribute":[ { "Name":"andorid", "Count":15, "ServiceConfig":{ "PortsBindConfig":{ "NetServiceContainer":"uravi-service", "Ports":[ { "Protocol":"TCP", "BindType":"Mapping", "StartNodePorts":"31000-31009", "ContainerPorts":"4440-4449" }, { "Protocol":"TCP", "BindType":"PassThrough", "StartNodePorts":"59000-59000", "ContainerPorts":"59000-59000" }, { "Protocol":"UDP", "BindType":"PassThrough", "StartNodePorts":"40001-40010", "ContainerPorts":"40001-40010" } ] }, "ServiceContainerName":"android" } }, { "Name":"coturn", "Count":1, "ServiceConfig":{ "PortsBindConfig":{ "NetServiceContainer":"coturn", "Ports":[ { "Protocol":"TCP", "BindType":"PassThrough", "StartNodePorts":"3478-3478", "ContainerPorts":"3478-3478" }, { "Protocol":"UDP", "BindType":"PassThrough", "StartNodePorts":"3478-3478", "ContainerPorts":"3478-3478" } ] }, "ServiceContainerName":"coturn" } }, { "Name":"aic-manager", "Count":1, "ServiceConfig":null } ] }
ClusterNamestring

The name of the cluster.

ay-ads-hz-h
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The ID of the request.

50373E71-7710-4620-8AAB-133CCE49451C
TotalCountinteger

The total number of entries returned.

49

Examples

Sample success responses

JSONformat

{
  "Applications": {
    "Application": [
      {
        "AppList": {
          "App": [
            {
              "AppId": "e76f8985-7965-41fc-925b-9648bb6bf650",
              "AppInfo": "{\n    \"AppStatus\":{\n        \"Phase\":\"RUNNING\",\n        \"StatusDescrip\":\"{\\\"status\\\":\\\"UPDATE_SUCCESS\\\",\\\"step\\\":\\\"DONE\\\",\\\"descrip\\\":\\\"update to version:1022 success\\\",\\\"start_time\\\":\\\"2022-03-01 16:18:22\\\"}\",\n        \"UpdateTime\":\"2022-03-01 16:18:22\",\n        \"OrderStatus\":null\n    },\n    \"ResourceAttribute\":{\n        \"NetSecurityInfo\":null,\n        \"InitConfig\":null,\n        \"InventoryType\":\"Ens\",\n        \"InstanceSpec\":\"ens.gi6s-c12g1.large\",\n        \"SystemDiskSize\":100,\n        \"DataDiskSize\":0,\n        \"BandwithOut\":5000,\n        \"SchedulingStrategy\":\"Disperse\",\n        \"ImageId\":\"m-5or73kzkuxytv7hh6wxr6yc5q\",\n        \"ResourceType\":\"Linux\",\n        \"AreaLevel\":\"National\",\n        \"IpType\":\"PublicIP\"\n    },\n    \"WorkloadAttribute\":[\n        {\n            \"Name\":\"andorid\",\n            \"Count\":15,\n            \"ServiceConfig\":{\n                \"PortsBindConfig\":{\n                    \"NetServiceContainer\":\"uravi-service\",\n                    \"Ports\":[\n                        {\n                            \"Protocol\":\"TCP\",\n                            \"BindType\":\"Mapping\",\n                            \"StartNodePorts\":\"31000-31009\",\n                            \"ContainerPorts\":\"4440-4449\"\n                        },\n                        {\n                            \"Protocol\":\"TCP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"59000-59000\",\n                            \"ContainerPorts\":\"59000-59000\"\n                        },\n                        {\n                            \"Protocol\":\"UDP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"40001-40010\",\n                            \"ContainerPorts\":\"40001-40010\"\n                        }\n                    ]\n                },\n                \"ServiceContainerName\":\"android\"\n            }\n        },\n        {\n            \"Name\":\"coturn\",\n            \"Count\":1,\n            \"ServiceConfig\":{\n                \"PortsBindConfig\":{\n                    \"NetServiceContainer\":\"coturn\",\n                    \"Ports\":[\n                        {\n                            \"Protocol\":\"TCP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"3478-3478\",\n                            \"ContainerPorts\":\"3478-3478\"\n                        },\n                        {\n                            \"Protocol\":\"UDP\",\n                            \"BindType\":\"PassThrough\",\n                            \"StartNodePorts\":\"3478-3478\",\n                            \"ContainerPorts\":\"3478-3478\"\n                        }\n                    ]\n                },\n                \"ServiceContainerName\":\"coturn\"\n            }\n        },\n        {\n            \"Name\":\"aic-manager\",\n            \"Count\":1,\n            \"ServiceConfig\":null\n        }\n    ]\n}"
            }
          ]
        },
        "ClusterName": "ay-ads-hz-h"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C",
  "TotalCount": 49
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

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

Change history

Change timeSummary of changesOperation
2023-12-21API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change