Query application details using DescribeApplication - ENS

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeApplication

get

*All Resource

*

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: National: Chinese mainland Big: area Middle: province Small: city RegionId: edge node Default value: National. Valid values: Big : Small : National : RegionId : Middle :	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 filtering condition.	[{\"regionCode\": \"cn-wuxi-telecom_unicom_cmcc-3\", \"ispCode\": \"telecom\", \"count\": 2 },{ \"regionCode\": \"cn-shanghai-cmcc\", \"count\": 4 }]

Response elements

Element	Type	Description	Example
	object
Application	string	The returned application information.	{ "AppMetaData":{ "AppId":"b0b27670-87d5-4c40-9ea8-adeeec2986ce", "AppName":"asp-yz", "ClusterName":"poc", "AppStableVersion":"0825", "AppType":"Scheduler", "Description":"DailyTestCPUenvironment", "CreateTime":"2020-08-25 16:36:16" }, "AppStatus":{ "Phase":"RUNNING", "StatusDescrip":"{\"status\":\"UPDATE_SUCCESS\",\"step\":\"DONE\",\"descrip\":\"delVersion success\",\"start_time\":\"2021-08-18 14:46:45\"}", "UpdateTime":"2021-08-18 14:46:45" }, "ResourceAttribute":{ "ResourceType":"Ens", "ResourceAgent":"Linux", "InstanceSpec":"ens.sn1.large", "SystemDiskSize":40, "DataDiskSize":0, "BandwithOut":10, "SchedulingStrategy":"Disperse", "AreaLevel":"RegionId", "IpType":"PublicIP" }, "WorkloadAttribute":[ { "Name":"andorid", "PodCount":7, "ServiceConfig":{ "PortsBindConfig":{ "NetServiceContainer":"aspserver-android", "Ports":[ { "Protocol":"TCP", "BindType":"PassThrough", "StartNodePorts":"5000-5000", "ContainerPorts":"5000-5000" }, { "Protocol":"UDP", "BindType":"PassThrough", "StartNodePorts":"4001-4010", "ContainerPorts":"4001-4010" } ] }, "ServiceContainerName":"android" } }, { "Name":"aic-manager", "PodCount":1, "ServiceConfig":null } ], "DetailStat":{ "Level":"Small", "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "AppVersionStat":[ { "AppVersion":"08102", "Descrip":"Web consoleTest2", "CreateTime":"2021-08-10 11:20:04", "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "DistrictStat":[ { "AreaCode":"310100", "AreaName":"East China,,", "RegionCode":"310100", "RegionName":"", "IspCode":"telecom", "RegionIds":[ "cn-shanghai-telecom-2" ], "InstanceTotalCount":1, "InstanceRunningCount":0, "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":null }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":null } ], "InstanceStat":[ { "InstanceId":"i-xxxxxxx", "PublicIps":[ { "PublicIp":"101.227.7.12", "Isp":"telecom" } ], "InternalIps":[ { "Ip":"10.0.1.4" } ], "RegionId":"cn-shanghai-telecom-2", "NcName":"", "InstanceStatus":"", "CreateTime":"2020-09-12 22:33:08", "PodCountStat":[ { "Name":"andorid", "RunningCount":7, "ProducedCount":7, "Devices":[ { "Name":"asp-yz-andorid-08102-zjzmcyaw-0", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-1", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-2", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-3", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-4", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-5", "Status":"Running", "Ports":null }, { "Name":"asp-yz-andorid-08102-zjzmcyaw-6", "Status":"Running", "Ports":null } ] }, { "Name":"aic-manager", "RunningCount":1, "ProducedCount":1, "Devices":[ { "Name":"asp-yz-aic-manager-08102-zjzmcyaw-0", "Status":"Running", "Ports":null } ] } ], "AppVersionDescrip":"" } ] } ] } ] } }
RequestId	string	The ID of the request.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "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\":\"DailyTestCPUenvironment\",\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\":\"Web consoleTest2\",\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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.