DescribeAppInfo-AI Guardrails(AI Guardrails)-阿里云帮助中心

Queries the information of an application.

Operation description

Billing information: This operation is free of charge.
Query timeout: Set the query interval to 480 seconds (that is, query results 480 seconds after you submit an asynchronous detection task). The maximum interval is 3 days. Otherwise, results are automatically deleted.
The queries per second (QPS) limit for a single user is 100. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

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

yundun-greenweb:DescribeAppInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	27.189.***.27
Lang	string	No	The language type of the application. Valid values: zh: Chinese. en: English.	zh
TotalCount	integer	No	The total number of entries.	511
PageSize	integer	No	The number of entries per page.	10
CurrentPage	integer	No	The current page number.	1
Platform	string	No	The package type. Valid values: ANDROID, IOS.	ANDROID

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	513
AppInfoList	array<object>	The list of application information.
	array<object>	The list of application information.
Type	integer	The application type. Valid values: 0: Android application. 1: iOS application.	custom_llm_template
EndDate	string	The expiration date of the application. Format: yyyy-MM-dd HH:mm:ss.	2025-09-05 10:13:44
PackageName	string	The package name of the application.	com.haibukeji.app
Icon	string	The icon of the application.	@lADPDetfgMsFFUvNAkjNAkg
StartDate	string	The start time when the application goes live. The value is a standard time string with time zone (UTC+8) in the format of YYYY-MM-DD HH:mm:ss +0800.	2024-08-01 00:00:00 +0800
Name	string	The name of the application.	test007_
Id	integer	The application ID.	16478
PackageInfo	object	The package information of the application.
Version	string	The package version of the application.	4
DebugPackageInfo	object	The debug version information.
Version	string	The debug version.	4

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "PageSize": 10,
  "TotalCount": 513,
  "AppInfoList": [
    {
      "Type": 0,
      "EndDate": "2025-09-05 10:13:44",
      "PackageName": "com.haibukeji.app",
      "Icon": "@lADPDetfgMsFFUvNAkjNAkg",
      "StartDate": "2024-08-01 00:00:00 +0800",
      "Name": "test007_",
      "Id": 16478,
      "PackageInfo": {
        "Version": "4"
      },
      "DebugPackageInfo": {
        "Version": "4"
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.