DescribeApps - Cloud Phone - Alibaba Cloud Documentation Center

Queries applications.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
AppIdList	array	No	The IDs of the applications.
	string	No	The ID of the application.	1234
AppName	string	No	The name of the application.	应用名称
BizRegionId	string	No	Region id.	cn-hangzhou
Status	string	No	The status of the application. Valid values: FAILED : The application failed to be created. NORMAL : The application is available. CREATING : The application is being created.	NORMAL
InstallationStatus	string	No	The installation/uninstallation status of the application. Valid values: INSTALLFAILED: The application failed to be installed. UNINSTALLING: The application is being uninstalled. INSTALLING: The application is being installed. UNINSTALLED: The application is uninstalled. INSTALLED: The application is installed. UNINSTALLFAILED: The application failed to be uninstalled. Valid values: INSTALLFAILED : UNINSTALLING : INSTALLING : UNINSTALLED : INSTALLED : UNINSTALLFAILED :	INSTALLING
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 100. Default value: 10.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the parameter is left empty, the data is queried from the first entry.	AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****
MD5	string	No	The value of MD5.	009ee07fe13a29fa0c180ed0b6bc****
AppType	string	No	Note This parameter is for internal use now.	-

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	CB95E410-FD1D-53C5-9F7D-93CC44D7****
TotalCount	string	The total number of entries returned.	10
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.	AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****
Data	array<object>	The objects that are returned.
	object	The returned result object.
AppName	string	The name of the application.	testapp
AppId	integer	The ID of the application.	10404
AndroidAppVersion	string	The version of the application.	1.0.0
IconUrl	string	The icon URL of the application.	https://test.png
InstanceGroupList	array	The list of instance groups where the application is installed.
	string	The ID of the instance group where the application is installed.	ag-fasf****
GmtCreate	string	The time when the application was created.	2022-08-11 17:45:03
GmtModified	string	The time when the application was last modified.	2022-08-11 17:45:03
Description	string	The description of the application.	CustomApp
Status	string	The status of the application. Valid values: FAILED: The application failed to be created. NORMAL: The application is available. CREATING: The application is being created. Valid values: FAILED : NORMAL : CREATING :	NORMAL
InstallationStatus	string	The installation/uninstallation status of the application. Valid values: INSTALLFAILED: The application failed to be installed. UNINSTALLING: The application is being uninstalled. INSTALLING: The application is being installed. UNINSTALLED: The application is uninstalled. INSTALLED: The application is installed. UNINSTALLFAILED: The application failed to be uninstalled. Valid values: INSTALLFAILED : UNINSTALLING : INSTALLING : UNINSTALLED : INSTALLED : UNINSTALLFAILED :	INSTALLING
BizRegionId	string	Region id.	cn-hangzhou
PackageName	string	The name of the application package.	com.example.chinalife
ApkSize	string	Apk size.	2.7
MD5	string	The value of MD5.	009ee07fe13a29fa0c180ed0b6bc****
AppType	string	The application type. Valid values: Normal : Standard application System_Signature : System-signed application	Normal

Examples

Success response

JSON format

{
  "RequestId": "CB95E410-FD1D-53C5-9F7D-93CC44D7****",
  "TotalCount": "10",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6l5V9uON****",
  "Data": [
    {
      "AppName": "testapp",
      "AppId": 10404,
      "AndroidAppVersion": "1.0.0",
      "IconUrl": "https://test.png",
      "InstanceGroupList": [
        "ag-fasf****"
      ],
      "GmtCreate": "2022-08-11 17:45:03",
      "GmtModified": "2022-08-11 17:45:03",
      "Description": "CustomApp",
      "Status": "NORMAL",
      "InstallationStatus": "INSTALLING",
      "BizRegionId": "cn-hangzhou",
      "PackageName": "com.example.chinalife",
      "ApkSize": "2.7",
      "MD5": "009ee07fe13a29fa0c180ed0b6bc****",
      "AppType": "Normal"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.