Queries the basic properties, resources, and container status of an application.
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:DescribeApplication | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AppId | string | Yes | The ID of the application. You can call the ListApplications operation to obtain the application ID. | a2bac6f4-75dc-455e-8389-2dc8e47526d3 |
| AppVersions | string | No | 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 |
| Level | string | No | The region level by which edge resources of the application are collected. The value is of the enumeration type. Valid values:
Default value: National. | National |
| OutDetailStatParams | string | No | 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} |
| ResourceSelector | string | No | The resource filter. | [{\"regionCode\": \"cn-wuxi-telecom_unicom_cmcc-3\", \"ispCode\": \"telecom\", \"count\": 2 },{ \"regionCode\": \"cn-shanghai-cmcc\", \"count\": 4 }] |
Response parameters
Examples
Sample success responses
JSONformat
{
"Application": "{\n \"AppMetaData\":{\n \"AppId\":\"b0b27670-87d5-4c40-9ea8-adeeec2986ce\",\n \"AppName\":\"asp-yz\",\n \"ClusterName\":\"poc\",\n \"AppStableVersion\":\"0825\",\n \"AppType\":\"Scheduler\",\n \"Description\":\"Daily testing CPU environment\",\n \"CreateTime\":\"2020-08-25 16:36:16\"\n },\n \"AppStatus\":{\n \"Phase\":\"RUNNING\",\n \"StatusDescrip\":\"{\\\"status\\\":\\\"UPDATE_SUCCESS\\\",\\\"step\\\":\\\"DONE\\\",\\\"descrip\\\":\\\"delVersion success\\\",\\\"start_time\\\":\\\"2021-08-18 14:46:45\\\"}\",\n \"UpdateTime\":\"2021-08-18 14:46:45\"\n },\n \"ResourceAttribute\":{\n \"ResourceType\":\"Ens\",\n \"ResourceAgent\":\"Linux\",\n \"InstanceSpec\":\"ens.sn1.large\",\n \"SystemDiskSize\":40,\n \"DataDiskSize\":0,\n \"BandwithOut\":10,\n \"SchedulingStrategy\":\"Disperse\",\n \"AreaLevel\":\"RegionId\",\n \"IpType\":\"PublicIP\"\n },\n \"WorkloadAttribute\":[\n {\n \"Name\":\"andorid\",\n \"PodCount\":7,\n \"ServiceConfig\":{\n \"PortsBindConfig\":{\n \"NetServiceContainer\":\"aspserver-android\",\n \"Ports\":[\n {\n \"Protocol\":\"TCP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"5000-5000\",\n \"ContainerPorts\":\"5000-5000\"\n },\n {\n \"Protocol\":\"UDP\",\n \"BindType\":\"PassThrough\",\n \"StartNodePorts\":\"4001-4010\",\n \"ContainerPorts\":\"4001-4010\"\n }\n ]\n },\n \"ServiceContainerName\":\"android\"\n }\n },\n {\n \"Name\":\"aic-manager\",\n \"PodCount\":1,\n \"ServiceConfig\":null\n }\n ],\n \"DetailStat\":{\n \"Level\":\"Small\",\n \"InstanceTotalCount\":1,\n \"InstanceRunningCount\":0,\n \"PodCountStat\":[\n {\n \"Name\":\"andorid\",\n \"RunningCount\":7,\n \"ProducedCount\":7,\n \"Devices\":null\n },\n {\n \"Name\":\"aic-manager\",\n \"RunningCount\":1,\n \"ProducedCount\":1,\n \"Devices\":null\n }\n ],\n \"AppVersionStat\":[\n {\n \"AppVersion\":\"08102\",\n \"Descrip\":\"White Screen Test 2\",\n \"CreateTime\":\"2021-08-10 11:20:04\",\n \"InstanceTotalCount\":1,\n \"InstanceRunningCount\":0,\n \"PodCountStat\":[\n {\n \"Name\":\"andorid\",\n \"RunningCount\":7,\n \"ProducedCount\":7,\n \"Devices\":null\n },\n {\n \"Name\":\"aic-manager\",\n \"RunningCount\":1,\n \"ProducedCount\":1,\n \"Devices\":null\n }\n ],\n \"DistrictStat\":[\n {\n \"AreaCode\":\"310100\",\n \"AreaName\":\"East China,,\",\n \"RegionCode\":\"310100\",\n \"RegionName\":\"\",\n \"IspCode\":\"telecom\",\n \"RegionIds\":[\n \"cn-shanghai-telecom-2\"\n ],\n \"InstanceTotalCount\":1,\n \"InstanceRunningCount\":0,\n \"PodCountStat\":[\n {\n \"Name\":\"andorid\",\n \"RunningCount\":7,\n \"ProducedCount\":7,\n \"Devices\":null\n },\n {\n \"Name\":\"aic-manager\",\n \"RunningCount\":1,\n \"ProducedCount\":1,\n \"Devices\":null\n }\n ],\n \"InstanceStat\":[\n {\n \"InstanceId\":\"i-xxxxxxx\",\n \"PublicIps\":[\n {\n \"PublicIp\":\"101.227.7.12\",\n \"Isp\":\"telecom\"\n }\n ],\n \"InternalIps\":[\n {\n \"Ip\":\"10.0.1.4\"\n }\n ],\n \"RegionId\":\"cn-shanghai-telecom-2\",\n \"NcName\":\"\",\n \"InstanceStatus\":\"\",\n \"CreateTime\":\"2020-09-12 22:33:08\",\n \"PodCountStat\":[\n {\n \"Name\":\"andorid\",\n \"RunningCount\":7,\n \"ProducedCount\":7,\n \"Devices\":[\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-0\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-1\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-2\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-3\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-4\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-5\",\n \"Status\":\"Running\",\n \"Ports\":null\n },\n {\n \"Name\":\"asp-yz-andorid-08102-zjzmcyaw-6\",\n \"Status\":\"Running\",\n \"Ports\":null\n }\n ]\n },\n {\n \"Name\":\"aic-manager\",\n \"RunningCount\":1,\n \"ProducedCount\":1,\n \"Devices\":[\n {\n \"Name\":\"asp-yz-aic-manager-08102-zjzmcyaw-0\",\n \"Status\":\"Running\",\n \"Ports\":null\n }\n ]\n }\n ],\n \"AppVersionDescrip\":\"\"\n }\n ]\n }\n ]\n }\n ]\n }\n}",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
| 400 | NoPermission | Permission denied. | - |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
| 400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
| 400 | ens.interface.error | An error occurred while calling the API. | - |
| 400 | CallInterface | Call 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 time | Summary of changes | Operation |
|---|---|---|
| 2024-05-11 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-12-21 | API Description Update. The Error code has changed | View Change Details |